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

A PRMClass is an object of a PRM representing a fragment of a Bayesian network which can be instantiated in PRMInstance. More...

#include <agrum/PRM/elements/PRMClass.h>

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

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

Public Member Functions
Constructors & destructor.
	PRMClass (const std::string &name)
	Default constructor. More...
	PRMClass (const std::string &name, PRMClass< GUM_SCALAR > &super, bool delayInheritance=false)
	Constructor for building a subclass of super. More...
	PRMClass (const std::string &name, const Set< PRMInterface< GUM_SCALAR > * > &set, bool delayInheritance=false)
	Constructor for building a Class<GUM_SCALAR> implementing several each interface in set. More...
	PRMClass (const std::string &name, PRMClass< GUM_SCALAR > &super, const Set< PRMInterface< GUM_SCALAR > * > &set, bool delayInheritance=false)
	Constructor for building a subclass of super and implementing each interface in set. More...
	PRMClass (const PRMClass< GUM_SCALAR > &source)=delete
	Copy constructor. More...
	PRMClass (const PRMClass< GUM_SCALAR > &&source)=delete
	Move constructor. More...
PRMClass< GUM_SCALAR > &	operator= (const PRMClass< GUM_SCALAR > &source)=delete
	Copy operator. Don't use it. More...
PRMClass< GUM_SCALAR > &	operator= (const PRMClass< GUM_SCALAR > &&source)=delete
	Move operator. Don't use it. More...
virtual	~PRMClass ()
	Destructor. More...
virtual PRMObject::prm_type	obj_type () const
	Implementation of pure virtual method of PRMObject. More...
Graphical operator
PRMClassElement< GUM_SCALAR > &	get (NodeId id)
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(NodeId). More...
const PRMClassElement< GUM_SCALAR > &	get (NodeId id) const
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(NodeId). More...
PRMClassElement<GUM_SCALAR> getters and setters
virtual bool	isOutputNode (const PRMClassElement< GUM_SCALAR > &elt) const
	Returns true if elt is an output node. More...
bool	isCastDescendant (const std::string &safe_name) const
	Return true if the attribute named safe_name is a cast descendant. More...
PRMClassElement< GUM_SCALAR > &	get (const std::string &name)
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(const std::string&). More...
const PRMClassElement< GUM_SCALAR > &	get (const std::string &name) const
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(const std::string&). More...
virtual NodeId	add (PRMClassElement< GUM_SCALAR > *elt)
	See gum::prm::add(PRMClassElement<GUM_SCALAR>*). More...
virtual NodeId	overload (PRMClassElement< GUM_SCALAR > *elt)
	See gum::prm::overload(PRMClassElement<GUM_SCALAR>*). More...
virtual void	addArc (const std::string &tail, const std::string &head)
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::addArc(). More...
const Set< PRMAttribute< GUM_SCALAR > *> &	attributes () const
	Returns the set of PRMAttribute<GUM_SCALAR> of this Class<GUM_SCALAR>. More...
const Set< PRMParameter< GUM_SCALAR > *> &	parameters () const
	Returns the set of parameters of this Class<GUM_SCALAR>. More...
HashTable< std::string, const PRMParameter< GUM_SCALAR > *>	scope () const
	Returns all the parameters in the scope of this class. More...
const Set< PRMAggregate< GUM_SCALAR > *> &	aggregates () const
	Returns the set of PRMAggregate<GUM_SCALAR> of this Class<GUM_SCALAR>. More...
const Set< PRMReferenceSlot< GUM_SCALAR > *> &	referenceSlots () const
	Returns the set of PRMReferenceSlot<GUM_SCALAR> of this Class<GUM_SCALAR>. More...
const Set< PRMSlotChain< GUM_SCALAR > *> &	slotChains () const
	Returns the set of PRMSlotChain<GUM_SCALAR> of this Class<GUM_SCALAR>. More...
Inheritance methods
virtual bool	isSubTypeOf (const PRMClassElementContainer< GUM_SCALAR > &cec) const
	Test if this Class<GUM_SCALAR> is a subclass of cec. More...
const PRMClass< GUM_SCALAR > &	super () const
	Returns the super Class<GUM_SCALAR> of this Class<GUM_SCALAR>. More...
const Set< PRMInterface< GUM_SCALAR > *> &	implements () const
	Returns the Set of PRMInterface<GUM_SCALAR> implemented by this Class<GUM_SCALAR>. More...
const Set< PRMClass< GUM_SCALAR > *> &	extensions () const
	Returns the set of Class<GUM_SCALAR> which are direct sub-Class<GUM_SCALAR> of this Class<GUM_SCALAR>. More...
Getters & setters operators
PRMClassElement< GUM_SCALAR > &	operator[] (NodeId id)
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](NodeId). More...
const PRMClassElement< GUM_SCALAR > &	operator[] (NodeId id) const
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](NodeId). More...
PRMClassElement< GUM_SCALAR > &	operator[] (const std::string &name)
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](const std::string&). More...
const PRMClassElement< GUM_SCALAR > &	operator[] (const std::string &name) const
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](const std::string&). More...
For custom inheritance
void	inheritReferenceSlots ()
void	inheritParameters ()
void	inheritAttributes ()
void	inheritAggregates ()
void	inheritSlotChains ()
void	initializeInheritance ()
void	completeInheritance (const std::string &attr)
Getters on the gum::PRMClassElement<GUM_SCALAR>.
virtual bool	belongsTo (const PRMClassElement< GUM_SCALAR > &elt) const
	Returns true if elt belongs to this PRMClassElementContainer. More...
virtual bool	exists (const std::string &name) const
	Returns true if a member with the given name exists in this PRMClassElementContainer or in the PRMClassElementContainer hierarchy. More...
virtual bool	isInputNode (const PRMClassElement< GUM_SCALAR > &elt) const
	Returns true if the node is an input node. More...
virtual void	setInputNode (const PRMClassElement< GUM_SCALAR > &elt, bool b)
	Set the input flag value of id at b. More...
virtual void	setOutputNode (const PRMClassElement< GUM_SCALAR > &elt, bool b)
	Set the output flag value of id at b. More...
virtual bool	isInnerNode (const PRMClassElement< GUM_SCALAR > &elt) const
	Returns true if the node is an inner node. More...
Graphical operator
virtual bool	exists (NodeId id) const
	Returns true if a member with the given id exists in this PRMClassElementContainer or in the PRMClassElementContainer hierarchy. More...
virtual const DAG &	containerDag () const
	Returns the gum::DAG of this PRMClassElementContainer. More...
Inheritance getters and setters
virtual bool	isSuperTypeOf (const PRMClassElementContainer< GUM_SCALAR > &cec) const
	Test if this PRMClassElementContainer is a super type of cec. More...
Getters & setters.
const std::string &	name () const
	Returns the name of this object. More...
void	name (const std::string &name)
	Change the name of the PRM Object. More...
Operators
bool	operator== (const PRMObject &obj) const
	To PRMObject are equal if they have the same name (which is unique). More...
bool	operator!= (const PRMObject &obj) const
	To PRMObject are equal if they have the same name (which is unique). More...

Protected Member Functions
virtual const DAG &	dag_ () const
	returns a constant reference over this interface's dag. More...
virtual DAG &	dag_ ()
	Returns a non constant reference over this PRMInterface<GUM_SCALAR>'s DAG. More...
void	findAllSubtypes_ (Set< PRMClassElementContainer< GUM_SCALAR > * > &set)
	Fills set with all the subtypes of this Class<GUM_SCALAR>. More...
void	updateDescendants_ (const PRMClassElement< GUM_SCALAR > &elt)
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>(const PRMClassElement<GUM_SCALAR>&). More...
virtual std::pair< bool, bool > &	getIOFlag_ (const PRMClassElement< GUM_SCALAR > &elt)
	Returns the IO flags of a PRMClassElement<GUM_SCALAR>. More...
virtual const std::pair< bool, bool > &	getIOFlag_ (const PRMClassElement< GUM_SCALAR > &elt) const
	Returns the IO flags of a PRMClassElement<GUM_SCALAR>. More...
virtual void	setIOFlag_ (const PRMClassElement< GUM_SCALAR > &elt, const std::pair< bool, bool > &flags)
	Defines the IO flags of a PRMClassElement<GUM_SCALAR>. More...
virtual void	copyIOFlags_ (const PRMClassElementContainer< GUM_SCALAR > &c)
	Copy the IO Flags of c in this PRMClassElementContainer. More...

Friends
class	PRMInterface< GUM_SCALAR >

PRMClassElement<GUM_SCALAR> members
HashTable< std::string, PRMClassElement< GUM_SCALAR > *>	_nameMap_
	Mapping between a member's name and itself. Used for fast access to a member given it's name. More...
Set< PRMAttribute< GUM_SCALAR > *>	_attributes_
	The sequence of PRMAttribute<GUM_SCALAR>s. More...
Set< PRMReferenceSlot< GUM_SCALAR > *>	_referenceSlots_
	The sequence of PRMReferenceSlot<GUM_SCALAR>. More...
Set< PRMAggregate< GUM_SCALAR > *>	_aggregates_
	The sequence of aggregate. More...
Set< PRMSlotChain< GUM_SCALAR > *>	_slotChains_
	The set of gum::PRMSlotChain<GUM_SCALAR>s. More...
Set< PRMParameter< GUM_SCALAR > *>	_parameters_
	The Set of parameters in this Class<GUM_SCALAR>. More...
void	_addCastDescendants_ (PRMClassElement< GUM_SCALAR > *attr)
	Recursively adds cast descendant of attr in this Class<GUM_SCALAR>. More...
void	_addCastDescendants_ (PRMAttribute< GUM_SCALAR > *start, PRMAttribute< GUM_SCALAR > *end)
	Recursively adds cast descendant from start to end in this Class<GUM_SCALAR>. More...

Inheritance members
PRMClass< GUM_SCALAR > *	_superClass_
	The alternate PRMClassElementContainer<GUM_SCALAR> searched for elements defined in this. Note that this is first searched for gum::PRMClassElement<GUM_SCALAR>. More...
Set< PRMInterface< GUM_SCALAR > *> *	_implements_
	The Set of implemented interface of this. More...
Set< PRMClass< GUM_SCALAR > *>	_extensions_
	The set of Class<GUM_SCALAR> which are extension of this Class<GUM_SCALAR> (i.e. direct subtypes). More...
Bijection< const DiscreteVariable *, const DiscreteVariable *> *	_bijection_
	The bijection between variables in super and variables in this The bijection's firsts are attributes in this and its seconds are attributes in c. More...
HashFunc< PRMClassElementContainer< GUM_SCALAR > *>	_dummy_hashfunc_
	a dummy member used to fix a compilation issue in clang4 More...
void	_inheritClass_ (const PRMClass< GUM_SCALAR > &c)
	Proceed with the copy when this inherits c. More...
void	_implementInterfaces_ (bool delayInheritance)
	Proceed with the implementation of interfaces. More...
void	_checkInterfaces_ (PRMClassElement< GUM_SCALAR > *elt)
	Check that a given element respects all the class interfaces. More...
void	_checkInterface_ (PRMClassElement< GUM_SCALAR > *elt, PRMInterface< GUM_SCALAR > *i)
	Check that a given element respects a specific interface. More...
void	_checkRefInterfaces_ (PRMReferenceSlot< GUM_SCALAR > *elt)
	Check that a given element respects all the class interfaces. More...
void	_checkRefInterface_ (PRMReferenceSlot< GUM_SCALAR > *elt, PRMInterface< GUM_SCALAR > *i)
	Check that a given element respects a specific interface. More...
void	_addIOInterfaceFlags_ (PRMClassElement< GUM_SCALAR > *elt)
	Check if elt is present in an implementation. If it is, its IO flags are updated. More...
void	_addExtension_ (PRMClass< GUM_SCALAR > *c)
	This method is called when a sub-Class<GUM_SCALAR> of this Class<GUM_SCALAR> is created. More...
bool	_checkOverloadLegality_ (const PRMClassElement< GUM_SCALAR > *overloaded, const PRMClassElement< GUM_SCALAR > *overloader)
	Return true of overloaded can be overload by overloader. More...
void	_overloadAttribute_ (PRMAttribute< GUM_SCALAR > *overloader, PRMAttribute< GUM_SCALAR > *overloaded)
	Overloads an attribute. More...
void	_overloadAggregate_ (PRMAggregate< GUM_SCALAR > *overloader, PRMClassElement< GUM_SCALAR > *overloaded)
	Overloads an aggregate. More...
void	_overloadReference_ (PRMReferenceSlot< GUM_SCALAR > *overloader, PRMReferenceSlot< GUM_SCALAR > *overloaded)
	Overloads a reference slot. More...
void	_overloadParameter_ (PRMParameter< GUM_SCALAR > *overloader, PRMParameter< GUM_SCALAR > *overloaded)
	Overloads a parameter. More...

Built-in types.
enum	prm_type : char {   prm_type::ALL, prm_type::CLASS, prm_type::PRM_INTERFACE, prm_type::CLASS_ELT,   prm_type::TYPE, prm_type::SYSTEM, prm_type::INSTANCE }
	Enumeration of the different types of objects handled by a PRM. More...
static std::string	LEFT_CAST ()
	Enumeration of the different types of objects handled by a PRM. More...
static std::string	RIGHT_CAST ()
	Enumeration of the different types of objects handled by a PRM. More...
static std::string	enum2str (prm_type type)
	Returns the string representation of a PRMObject. More...
static INLINE bool	isClass (const PRMObject &obj)
	Returns true if obj_ptr is of type Class. More...
static INLINE bool	isInterface (const PRMObject &obj)
	Returns true if obj_ptr is of type PRMInterface. More...
static INLINE bool	isInstance (const PRMObject &obj)
	Returns true if obj_ptr is of type PRMInstance. More...

Detailed Description

template<typename GUM_SCALAR>
class gum::prm::PRMClass< GUM_SCALAR >

A PRMClass is an object of a PRM representing a fragment of a Bayesian network which can be instantiated in PRMInstance.

See also

PRMClassElement

Definition at line 65 of file PRMClass.h.

Member Enumeration Documentation

prm_type

enum gum::prm::PRMObject::prm_type : char

stronginherited

Enumeration of the different types of objects handled by a PRM.

The "all" type is used to tell that we want any kind of PRMType (useful with iterators for example). No PRMObject will ever have "all" as type.

Enumerator
ALL
CLASS
PRM_INTERFACE
CLASS_ELT
TYPE
SYSTEM
INSTANCE

Definition at line 68 of file PRMObject.h.

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

Constructor & Destructor Documentation

PRMClass() [1/6]

template<typename GUM_SCALAR >

gum::prm::PRMClass< GUM_SCALAR >::PRMClass ( const std::string &  name )

explicit

Default constructor.

Parameters

name	The class name.

Definition at line 39 of file PRMClass_tpl.h.

                                                          :
        PRMClassElementContainer< GUM_SCALAR >(name), _superClass_(nullptr), _implements_(nullptr),
        _bijection_(nullptr) {
      GUM_CONSTRUCTOR(PRMClass);
    }

PRMClass() [2/6]

template<typename GUM_SCALAR>

gum::prm::PRMClass< GUM_SCALAR >::PRMClass	(	const std::string &	name,
		PRMClass< GUM_SCALAR > &	super,
		bool	delayInheritance = false
	)

Constructor for building a subclass of super.

Parameters

name	The subclass name.
super	The super Class<GUM_SCALAR> of this.
delayInheritance	If true, inheritance will be delayed.

Definition at line 46 of file PRMClass_tpl.h.

                                                                               :
        PRMClassElementContainer< GUM_SCALAR >(name),
        _superClass_(&super), _implements_(nullptr),
        _bijection_(new Bijection< const DiscreteVariable*, const DiscreteVariable* >()) {
      GUM_CONSTRUCTOR(PRMClass);
      if (!delayInheritance) {
        _dag_ = super.containerDag();
        _inheritClass_(super);
      }
    }

PRMClass() [3/6]

template<typename GUM_SCALAR>

gum::prm::PRMClass< GUM_SCALAR >::PRMClass	(	const std::string &	name,
		const Set< PRMInterface< GUM_SCALAR > * > &	set,
		bool	delayInheritance = false
	)

Constructor for building a Class<GUM_SCALAR> implementing several each interface in set.

Parameters

name	The sub class name.
set	The Set of implemented interfaces.
delayInheritance	If true, inheritance will be delayed.

Definition at line 60 of file PRMClass_tpl.h.

                                                                                                 :
        PRMClassElementContainer< GUM_SCALAR >(name),
        _superClass_(nullptr), _implements_(new Set< PRMInterface< GUM_SCALAR >* >(set)),
        _bijection_(nullptr) {
      GUM_CONSTRUCTOR(PRMClass);

      if (!delayInheritance) { _implementInterfaces_(false); }
    }

PRMClass() [4/6]

template<typename GUM_SCALAR>

gum::prm::PRMClass< GUM_SCALAR >::PRMClass	(	const std::string &	name,
		PRMClass< GUM_SCALAR > &	super,
		const Set< PRMInterface< GUM_SCALAR > * > &	set,
		bool	delayInheritance = false
	)

Constructor for building a subclass of super and implementing each interface in set.

Parameters

name	The sub class name.
super	The super Class<GUM_SCALAR> of this.
set	The Set of implemented interfaces.
delayInheritance	If true, inheritance will be delayed.

Definition at line 72 of file PRMClass_tpl.h.

                                                                                                 :
        PRMClassElementContainer< GUM_SCALAR >(name),
        _superClass_(&super), _implements_(nullptr),
        _bijection_(new Bijection< const DiscreteVariable*, const DiscreteVariable* >()) {
      GUM_CONSTRUCTOR(PRMClass);
      if (!delayInheritance) {
        _dag_ = super.containerDag();
        _inheritClass_(super);
      }

      // Adding other implementation
      if (_implements_ == nullptr) {   // super has not created  _implements_
        _implements_ = new Set< PRMInterface< GUM_SCALAR >* >(set);
      } else {   // we just add the new implementations
        for (const auto elt: set) {
          _implements_->insert(elt);
        }
      }

      if (!delayInheritance) { _implementInterfaces_(false); }
    }

PRMClass() [5/6]

template<typename GUM_SCALAR>

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

delete

Copy constructor.

PRMClass() [6/6]

template<typename GUM_SCALAR>

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

delete

Move constructor.

~PRMClass()

template<typename GUM_SCALAR >

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

virtual

Destructor.

Definition at line 115 of file PRMClass_tpl.h.

                                      {
      GUM_DESTRUCTOR(PRMClass);

      for (const auto& elt: _nodeIdMap_) {
        delete elt.second;
      }

      if (_implements_) { delete _implements_; }

      if (_bijection_) { delete _bijection_; }
    }

Member Function Documentation

_addCastDescendants_() [1/2]

template<typename GUM_SCALAR>

void gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_ ( PRMClassElement< GUM_SCALAR > *  attr )

private

Recursively adds cast descendant of attr in this Class<GUM_SCALAR>.

Definition at line 666 of file PRMClass_tpl.h.

                                                                                         {
      auto                        parent = attr;
      PRMAttribute< GUM_SCALAR >* child  = 0;

      while (parent->type().isSubType()) {
        child = parent->getCastDescendant();

        // Check if id was reserved by one of the class interfaces
        bool found = false;
        try {
          for (auto i: implements()) {
            if (i->exists(child->safeName())) {
              child->setId(i->get(child->safeName()).id());
              found = true;
              break;
            }
          }
        } catch (NotFound&) {
          // No interface
        }
        if (!found) {
          child->setId(nextNodeId());
          _dag_.addNodeWithId(child->id());
        }
        _nodeIdMap_.insert(child->id(), child);
        // Only use child's safe name when adding to the name map!
        _nameMap_.insert(child->safeName(), child);
        _attributes_.insert(child);
        // Do not use Class<GUM_SCALAR>::insertArc(), child's CPF is already
        // initialized properly
        _dag_.addArc(parent->id(), child->id());

        parent = child;
      }
    }

_addCastDescendants_() [2/2]

template<typename GUM_SCALAR>

void gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_ ( PRMAttribute< GUM_SCALAR > *  start, PRMAttribute< GUM_SCALAR > *  end  )

private

Recursively adds cast descendant from start to end in this Class<GUM_SCALAR>.

Definition at line 898 of file PRMClass_tpl.h.

                                                                                       {
      PRMAttribute< GUM_SCALAR >* parent = start;
      PRMAttribute< GUM_SCALAR >* child  = 0;

      while (parent->type().superType() != end->type()) {
        child = parent->getCastDescendant();
        child->setId(nextNodeId());
        _nodeIdMap_.insert(child->id(), child);
        _dag_.addNodeWithId(child->id());
        // Only use child's safe name when adding to the name map!
        _nameMap_.insert(child->safeName(), child);
        _attributes_.insert(child);
        _addIOInterfaceFlags_(child);
        // Do not use Class<GUM_SCALAR>::insertArc(), child's CPF is already
        // initialized properly
        _dag_.addArc(parent->id(), child->id());
        parent = child;
      }

      parent->setAsCastDescendant(end);
      _dag_.addArc(parent->id(), end->id());
    }

_addExtension_()

template<typename GUM_SCALAR>

INLINE void gum::prm::PRMClass< GUM_SCALAR >::_addExtension_ ( PRMClass< GUM_SCALAR > *  c )

private

This method is called when a sub-Class<GUM_SCALAR> of this Class<GUM_SCALAR> is created.

Parameters

c	The Class<GUM_SCALAR> added as a direct sub-Class<GUM_SCALAR> of this.

Exceptions

DuplicateElement

Raised if c is already a sub-Class<GUM_SCALAR> of this.

Definition at line 1186 of file PRMClass_tpl.h.

                                                                                {
      _extensions_.insert(c);
    }

_addIOInterfaceFlags_()

template<typename GUM_SCALAR>

void gum::prm::PRMClass< GUM_SCALAR >::_addIOInterfaceFlags_ ( PRMClassElement< GUM_SCALAR > *  elt )

private

Check if elt is present in an implementation. If it is, its IO flags are updated.

Definition at line 932 of file PRMClass_tpl.h.

                                                                                         {
      // We only add IO Flags if elt matches is required by and interface
      if (_implements_ != nullptr) {
        for (const auto impl: *_implements_) {
          PRMInterface< GUM_SCALAR >* super = impl;
          while (super) {
            // If the attribute is defined in an interface, we set it as an
            // OutputNode
            if (impl->exists(elt->name())) {
              try {
                this->getIOFlag_(*elt).second = true;
              } catch (NotFound&) { this->setIOFlag_(*elt, std::make_pair(false, true)); }
            }
            try {
              super = &(super->super());
            } catch (NotFound&) { super = nullptr; }
          }
        }
      }
    }

_checkInterface_()

template<typename GUM_SCALAR>

void gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_ ( PRMClassElement< GUM_SCALAR > *  elt, PRMInterface< GUM_SCALAR > *  i  )

private

Check that a given element respects a specific interface.

Definition at line 518 of file PRMClass_tpl.h.

                                                                                    {
      const auto& i_elt   = i->get(elt->name());
      bool        is_attr = PRMClassElement< GUM_SCALAR >::isAttribute(i_elt);
      bool        is_agg  = PRMClassElement< GUM_SCALAR >::isAggregate(i_elt);

      if (!(is_attr || is_agg)) {
        GUM_ERROR(OperationNotAllowed, "Class does not respect it's interface")
      }

      if (!elt->type().isSubTypeOf(i_elt.type())) {
        GUM_ERROR(OperationNotAllowed, "Attribute type does not respect class interface")
      }

      if (elt->type() != i_elt.type()) {
        if (!this->exists(i_elt.safeName())) {
          GUM_ERROR(OperationNotAllowed, "Attribute type does not respect class interface")
        }
        elt = &(this->get(i_elt.safeName()));
      }

      // Node must be reserved by constructor
      if (!_dag_.existsNode(i_elt.id())) {
        GUM_ERROR(FatalError, "Class does not reserved implemented nodes")
      }

      // Removing unused node and changing to proper node
      if (elt->id() != i_elt.id()) {
        // Update cast descendants
        for (auto child: _dag_.children(elt->id())) {
          _dag_.addArc(i_elt.id(), child);
        }
        _dag_.eraseNode(elt->id());
      }
      _nodeIdMap_.erase(elt->id());
      elt->setId(i_elt.id());
      _nodeIdMap_.insert(elt->id(), elt);
    }

_checkInterfaces_()

template<typename GUM_SCALAR>

void gum::prm::PRMClass< GUM_SCALAR >::_checkInterfaces_ ( PRMClassElement< GUM_SCALAR > *  elt )

private

Check that a given element respects all the class interfaces.

Definition at line 507 of file PRMClass_tpl.h.

                                                                                     {
      try {
        for (auto i: implements()) {
          if (i->exists(elt->name())) { _checkInterface_(elt, i); }
        }
      } catch (NotFound&) {
        // No interface
      }
    }

_checkOverloadLegality_()

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMClass< GUM_SCALAR >::_checkOverloadLegality_ ( const PRMClassElement< GUM_SCALAR > *  overloaded, const PRMClassElement< GUM_SCALAR > *  overloader  )

private

Return true of overloaded can be overload by overloader.

Definition at line 1143 of file PRMClass_tpl.h.

                                                        {
      if (overloaded->elt_type() != overloader->elt_type()) { return false; }

      switch (overloaded->elt_type()) {
        case PRMClassElement< GUM_SCALAR >::prm_attribute: {
          if (!overloader->type().isSubTypeOf(overloaded->type())) { return false; }
          break;
        }

        case PRMClassElement< GUM_SCALAR >::prm_refslot: {
          const auto& new_slot_type
             = static_cast< const PRMReferenceSlot< GUM_SCALAR >* >(overloader)->slotType();
          const auto& old_slot_type
             = static_cast< const PRMReferenceSlot< GUM_SCALAR >* >(overloaded)->slotType();

          if (!new_slot_type.isSubTypeOf(old_slot_type)) { return false; }

          break;
        }

        case PRMClassElement< GUM_SCALAR >::prm_parameter: {
          auto overloaded_param = static_cast< const PRMParameter< GUM_SCALAR >* >(overloaded);
          auto overloader_param = static_cast< const PRMParameter< GUM_SCALAR >* >(overloader);

          return overloaded_param->valueType() == overloader_param->valueType();
          break;
        }

        default: {
          return false;
        }
      }
      return true;
    }

_checkRefInterface_()

template<typename GUM_SCALAR>

void gum::prm::PRMClass< GUM_SCALAR >::_checkRefInterface_ ( PRMReferenceSlot< GUM_SCALAR > *  elt, PRMInterface< GUM_SCALAR > *  i  )

private

Check that a given element respects a specific interface.

Definition at line 569 of file PRMClass_tpl.h.

                                                                                        {
      auto& i_elt = i->get(ref->name());
      if (i_elt.elt_type() != ref->elt_type()) {
        GUM_ERROR(OperationNotAllowed, "Class does not respect it's interface")
      }
      auto& i_ref = static_cast< PRMReferenceSlot< GUM_SCALAR >& >(i_elt);
      if (!ref->slotType().isSubTypeOf(i_ref.slotType())) {
        GUM_ERROR(OperationNotAllowed, "ReferenceSlot type does not respect class interface")
      }
      // Node must be reserved by constructor
      if (!_dag_.exists(i_ref.id())) {
        GUM_ERROR(FatalError,
                  "class " << this->name() << " does not respect interface " << i->name()
                           << " implementation");
      }
      // Removing unused node and changin to propoer node
      if (ref->id() != i_ref.id()) { _dag_.eraseNode(ref->id()); }
      _nodeIdMap_.erase(ref->id());
      ref->setId(i_ref.id());
      _nodeIdMap_.insert(ref->id(), ref);
    }

_checkRefInterfaces_()

template<typename GUM_SCALAR>

void gum::prm::PRMClass< GUM_SCALAR >::_checkRefInterfaces_ ( PRMReferenceSlot< GUM_SCALAR > *  elt )

private

Check that a given element respects all the class interfaces.

Definition at line 558 of file PRMClass_tpl.h.

                                                                                         {
      try {
        for (auto i: implements()) {
          if (i->exists(ref->name())) { _checkRefInterface_(ref, i); }
        }
      } catch (NotFound&) {
        // No interface to check
      }
    }

_implementInterfaces_()

template<typename GUM_SCALAR >

void gum::prm::PRMClass< GUM_SCALAR >::_implementInterfaces_ ( bool  delayInheritance )

private

Proceed with the implementation of interfaces.

Definition at line 98 of file PRMClass_tpl.h.

                                                                              {
      for (const auto impl: *_implements_) {
        impl->_addImplementation_(this);
        if ((!_superClass_) || (!super().isSubTypeOf(*impl)) || delayedInheritance) {
          // Reserve reference id in DAG
          for (auto ref: impl->referenceSlots()) {
            _dag_.addNodeWithId(ref->id());
          }
          // Reserve attribute id in DAG
          for (auto attr: impl->attributes()) {
            _dag_.addNodeWithId(attr->id());
          }
        }
      }
    }

_inheritClass_()

template<typename GUM_SCALAR>

void gum::prm::PRMClass< GUM_SCALAR >::_inheritClass_ ( const PRMClass< GUM_SCALAR > &  c )

private

Proceed with the copy when this inherits c.

Definition at line 299 of file PRMClass_tpl.h.

                                                                               {
      if (_superClass_) {
        _superClass_->_addExtension_(this);
        // Adding implemented interfaces of c, if any
        if (c._implements_) {
          if (!_implements_) {
            _implements_ = new Set< PRMInterface< GUM_SCALAR >* >(*(c._implements_));
          } else {
            for (auto i: *(c._implements_)) {
              _implements_->insert(i);
            }
          }
        }

        // Copying attributes, the bijection's firsts are attributes in this and
        // its
        // seconds are attributes
        // in c.
        Bijection< const DiscreteVariable*, const DiscreteVariable* > bij;

        // Copying parameters
        for (const auto c_param: c._parameters_) {
          auto param = new PRMParameter< GUM_SCALAR >(c_param->name(),
                                                      c_param->valueType(),
                                                      c_param->value());

          _parameters_.insert(param);

          param->setId(c_param->id());
          _nodeIdMap_.insert(param->id(), param);
          _nameMap_.insert(param->name(), param);
        }

        // Copying attributes
        for (const auto c_attr: c._attributes_) {
          // using multiDimSparse to prevent unecessary memory allocation for
          // large arrays (the potentials are copied latter)
          auto attr = c_attr->newFactory(*this);

          bij.insert(&(c_attr->type().variable()), &(attr->type().variable()));
          attr->setId(c_attr->id());
          _nodeIdMap_.insert(attr->id(), attr);
          _attributes_.insert(attr);

          if (c._nameMap_[c_attr->name()] == c._nameMap_[c_attr->safeName()]) {
            _nameMap_.insert(attr->name(), attr);
          }

          _nameMap_.insert(attr->safeName(), attr);
        }

        // Copying aggregates
        for (const auto c_agg: c._aggregates_) {
          PRMAggregate< GUM_SCALAR >* agg = nullptr;

          try {
            agg = new PRMAggregate< GUM_SCALAR >(c_agg->name(),
                                                 c_agg->agg_type(),
                                                 c_agg->type(),
                                                 c_agg->label());
          } catch (OperationNotAllowed&) {
            agg = new PRMAggregate< GUM_SCALAR >(c_agg->name(), c_agg->agg_type(), c_agg->type());
          }

          bij.insert(&(c_agg->type().variable()), &(agg->type().variable()));
          agg->setId(c_agg->id());
          _nodeIdMap_.insert(agg->id(), agg);
          _aggregates_.insert(agg);

          if (c._nameMap_[c_agg->name()] == c._nameMap_[c_agg->safeName()])
            _nameMap_.insert(agg->name(), agg);

          _nameMap_.insert(agg->safeName(), agg);
        }

        // Copying reference slots
        for (const auto c_refslot: c._referenceSlots_) {
          PRMReferenceSlot< GUM_SCALAR >* ref = new PRMReferenceSlot< GUM_SCALAR >(
             c_refslot->name(),
             const_cast< PRMClassElementContainer< GUM_SCALAR >& >(c_refslot->slotType()),
             c_refslot->isArray());

          ref->setId(c_refslot->id());
          _nodeIdMap_.insert(ref->id(), ref);
          _referenceSlots_.insert(ref);

          if (c._nameMap_[c_refslot->name()] == c._nameMap_[c_refslot->safeName()])
            _nameMap_.insert(ref->name(), ref);

          _nameMap_.insert(ref->safeName(), ref);
        }

        // Copying slot chains
        for (const auto c_slotchain: c._slotChains_) {
          // We just need to change the first PRMReferenceSlot<GUM_SCALAR> in
          // the
          // chain
          Sequence< PRMClassElement< GUM_SCALAR >* > chain(c_slotchain->chain());

          chain.setAtPos(0, _nameMap_[c_slotchain->chain().front()->name()]);

          PRMSlotChain< GUM_SCALAR >* sc
             = new PRMSlotChain< GUM_SCALAR >(c_slotchain->name(), chain);
          bij.insert(&(c_slotchain->type().variable()), &(sc->type().variable()));
          sc->setId(c_slotchain->id());
          _nodeIdMap_.insert(sc->id(), sc);
          _slotChains_.insert(sc);

          _nameMap_.insert(sc->name(), sc);
          _nameMap_.insert(sc->safeName(), sc);
        }

        // Copying dependencies yield by arcs
        for (const auto& arc: c.containerDag().arcs()) {
          _nodeIdMap_[arc.tail()]->addChild(*(_nodeIdMap_[arc.head()]));
          _nodeIdMap_[arc.head()]->addParent(*(_nodeIdMap_[arc.tail()]));
        }

        // Copying the IO flag
        this->copyIOFlags_(c);
        // Copying content of CPF
        for (const auto attr: c._attributes_) {
          auto a = static_cast< PRMAttribute< GUM_SCALAR >* >(_nameMap_[attr->safeName()]);
          a->copyCpf(bij, *attr);
        }
      }
    }

_overloadAggregate_()

template<typename GUM_SCALAR>

INLINE void gum::prm::PRMClass< GUM_SCALAR >::_overloadAggregate_ ( PRMAggregate< GUM_SCALAR > *  overloader, PRMClassElement< GUM_SCALAR > *  overloaded  )

private

Overloads an aggregate.

Definition at line 1136 of file PRMClass_tpl.h.

                                                                                              {
      _nameMap_.insert(overloader->safeName(), overloader);
      _aggregates_.insert(overloader);
    }

_overloadAttribute_()

template<typename GUM_SCALAR>

void gum::prm::PRMClass< GUM_SCALAR >::_overloadAttribute_ ( PRMAttribute< GUM_SCALAR > *  overloader, PRMAttribute< GUM_SCALAR > *  overloaded  )

private

Overloads an attribute.

Definition at line 765 of file PRMClass_tpl.h.

                                                                                             {
      _dag_.eraseParents(overloaded->id());

      // Checking if we have to add cast descendant
      if (overloader->type() != overloaded->type()) {
        overloader->setId(nextNodeId());
        _dag_.addNodeWithId(overloader->id());
        _nodeIdMap_.insert(overloader->id(), overloader);
        _nameMap_[overloader->name()] = overloader;
        _nameMap_.insert(overloader->safeName(), overloader);
        _attributes_.insert(overloader);
        _addCastDescendants_(overloader, overloaded);
      } else {
        overloader->setId(overloaded->id());
        _nodeIdMap_[overloader->id()]     = overloader;
        _nameMap_[overloader->name()]     = overloader;
        _nameMap_[overloader->safeName()] = overloader;
        _attributes_.erase(overloaded);
        _attributes_.insert(overloader);
        overloader->overload(overloaded);
        delete overloaded;
      }
    }

_overloadParameter_()

template<typename GUM_SCALAR>

void gum::prm::PRMClass< GUM_SCALAR >::_overloadParameter_ ( PRMParameter< GUM_SCALAR > *  overloader, PRMParameter< GUM_SCALAR > *  overloaded  )

private

Overloads a parameter.

Definition at line 886 of file PRMClass_tpl.h.

                                                                                             {
      overloader->setId(overloaded->id());
      _nodeIdMap_[overloader->id()]     = overloader;
      _nameMap_[overloader->name()]     = overloader;
      _nameMap_[overloader->safeName()] = overloader;
      _parameters_.erase(overloaded);
      _parameters_.insert(overloader);
      delete overloaded;
    }

_overloadReference_()

template<typename GUM_SCALAR>

void gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_ ( PRMReferenceSlot< GUM_SCALAR > *  overloader, PRMReferenceSlot< GUM_SCALAR > *  overloaded  )

private

Overloads a reference slot.

Definition at line 791 of file PRMClass_tpl.h.

                                                                                                 {
      // Adding overloading reference
      overloader->setId(overloaded->id());
      _nodeIdMap_[overloader->id()] = overloader;
      _nameMap_[overloader->name()] = overloader;
      _nameMap_.insert(overloader->safeName(), overloader);
      _referenceSlots_.insert(overloader);
      PRMSlotChain< GUM_SCALAR >*                sc   = 0;
      PRMReferenceSlot< GUM_SCALAR >*            ref  = 0;
      PRMClassElement< GUM_SCALAR >*             next = 0;
      std::vector< PRMSlotChain< GUM_SCALAR >* > toRemove, toAdd;

      // Updating PRMSlotChain<GUM_SCALAR> which started with overloaded
      for (const auto slotchain: _slotChains_) {
        // If the attribute pointed by this slotchain is overloaded, we need to
        // change the slotchain
        // names to it's safename version: ref.attr is replaced by
        // ref.(type)attr.
        if ((slotchain->chain().atPos(0) == overloaded)) {
          Sequence< PRMClassElement< GUM_SCALAR >* > seq;
          seq.insert(overloader);

          auto elt = ++(slotchain->chain().begin());

          while (elt != slotchain->chain().end()) {
            ref  = static_cast< PRMReferenceSlot< GUM_SCALAR >* >(seq.back());
            next = &(ref->slotType().get((*elt)->name()));
            seq.insert(next);
            ++elt;
          }

          // If the slotchain last element type changes, we change the slotchain
          // to
          // point towards the cast decendant
          // with the correct type
          if (seq.back()->type() != slotchain->lastElt().type()) {
            seq.erase(seq.back());
            seq.insert(&(static_cast< PRMReferenceSlot< GUM_SCALAR >* >(seq.back())
                            ->slotType()
                            .get(slotchain->lastElt().safeName())));
            std::string sc_name;
            std::string dot = ".";

            for (Size i = 0; i < seq.size() - 1; ++i) {
              sc_name += seq.atPos(i)->name() + dot;
            }

            sc_name += seq.back()->safeName();
            sc = new PRMSlotChain< GUM_SCALAR >(sc_name, seq);
            sc->setId(slotchain->id());

            for (const auto child: this->containerDag().children(sc->id())) {
              auto& elt = get(child);
              if (PRMClassElement< GUM_SCALAR >::isAttribute(elt)) {
                auto& attr     = static_cast< PRMAttribute< GUM_SCALAR >& >(elt);
                auto& old_type = slotchain->lastElt().type();
                auto& new_type = sc->lastElt().type();
                attr.swap(old_type, new_type);
              } else {
                GUM_ERROR(OperationNotAllowed, "unexpected ClassElement")
                // get( child ).cpf().replace(
                // slotchain->lastElt().type().variable(),
                // sc->lastElt().type().variable() );
              }
            }

            toAdd.push_back(sc);
            toRemove.push_back(slotchain);
          } else {
            // Types are identical, we just need to change the first reference
            slotchain->chain().setAtPos(0, overloader);
          }
        }
      }

      for (const auto torem: toRemove) {
        _nameMap_.erase(torem->name());
        _slotChains_.erase(torem);
        delete torem;
      }

      for (const auto toadd: toAdd) {
        _nameMap_.insert(toadd->name(), toadd);
        _nodeIdMap_[toadd->id()] = toadd;
        _slotChains_.insert(sc);
      }

      // Removing overloaded PRMReferenceSlot<GUM_SCALAR>
      _referenceSlots_.erase(overloaded);
      _nameMap_.erase(overloaded->safeName());
      delete overloaded;
    }

add()

template<typename GUM_SCALAR>

NodeId gum::prm::PRMClass< GUM_SCALAR >::add ( PRMClassElement< GUM_SCALAR > *  elt )

virtual

See gum::prm::add(PRMClassElement<GUM_SCALAR>*).

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

Definition at line 593 of file PRMClass_tpl.h.

                                                                         {
      if (_nameMap_.exists(elt->name())) {
        GUM_ERROR(DuplicateElement,
                  "name " << elt->name() << " already used by another ClassElement");
      }

      elt->setId(nextNodeId());
      _dag_.addNodeWithId(elt->id());
      _nodeIdMap_.insert(elt->id(), elt);
      _nameMap_.insert(elt->name(), elt);

      try {
        _nameMap_.insert(elt->safeName(), elt);
      } catch (DuplicateElement& e) {
        if (!(PRMClassElement< GUM_SCALAR >::isSlotChain(*elt)
              || PRMClassElement< GUM_SCALAR >::isParameter(*elt))) {
          throw DuplicateElement(e);
        }
      }

      switch (elt->elt_type()) {
        case PRMClassElement< GUM_SCALAR >::prm_attribute: {
          _attributes_.insert(static_cast< PRMAttribute< GUM_SCALAR >* >(elt));
          _addCastDescendants_(static_cast< PRMAttribute< GUM_SCALAR >* >(elt));

          // Update attribute or cast descendant id to respect implemented
          // interface
          _checkInterfaces_(elt);

          _addIOInterfaceFlags_(elt);
          break;
        }

        case PRMClassElement< GUM_SCALAR >::prm_aggregate: {
          _aggregates_.insert(static_cast< PRMAggregate< GUM_SCALAR >* >(elt));
          _addCastDescendants_(static_cast< PRMAttribute< GUM_SCALAR >* >(elt));

          // Update attribute or cast descendant id to respect implemented
          // interface
          _checkInterfaces_(elt);

          _addIOInterfaceFlags_(elt);
          break;
        }

        case PRMClassElement< GUM_SCALAR >::prm_refslot: {
          auto ref = static_cast< PRMReferenceSlot< GUM_SCALAR >* >(elt);
          _referenceSlots_.insert(ref);

          // Updating ref's id if ref implements an interface
          _checkRefInterfaces_(ref);
          break;
        }

        case PRMClassElement< GUM_SCALAR >::prm_slotchain: {
          _slotChains_.insert(static_cast< PRMSlotChain< GUM_SCALAR >* >(elt));
          break;
        }

        case PRMClassElement< GUM_SCALAR >::prm_parameter: {
          _parameters_.insert(static_cast< PRMParameter< GUM_SCALAR >* >(elt));
          break;
        }

        default: {
          GUM_ERROR(FatalError, "unknown ClassElement<GUM_SCALAR> type")
        }
      }

      return elt->id();
    }

addArc()

template<typename GUM_SCALAR >

void gum::prm::PRMClass< GUM_SCALAR >::addArc ( const std::string &  tail, const std::string &  head  )

virtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::addArc().

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

Definition at line 464 of file PRMClass_tpl.h.

                                                                    {
      PRMClassElement< GUM_SCALAR >* tail = 0;
      PRMClassElement< GUM_SCALAR >* head = 0;

      try {
        tail = _nameMap_[tail_name];
        head = _nameMap_[head_name];
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "tail and/or head of arc does not exists in this Class")
      }

      if ((tail->elt_type() == PRMClassElement< GUM_SCALAR >::prm_refslot)
          || (head->elt_type() == PRMClassElement< GUM_SCALAR >::prm_refslot)) {
        GUM_ERROR(OperationNotAllowed,
                  "a PRMReferenceSlot<GUM_SCALAR> can "
                  "not on neither side of an arc");
      }

      if ((tail->elt_type() == PRMClassElement< GUM_SCALAR >::prm_slotchain)
          && (head->elt_type() == PRMClassElement< GUM_SCALAR >::prm_slotchain)) {
        GUM_ERROR(OperationNotAllowed,
                  "illegal insertion of an arc between two SlotChain<GUM_SCALAR>")
      }

      if (!_dag_.existsArc(Arc(tail->id(), head->id()))) {
        _dag_.addArc(tail->id(), head->id());
      } else {
        GUM_ERROR(DuplicateElement, "duplicate arc " << tail_name << "->" << head_name)
      }

      get(tail->id()).addChild(get(head->id()));
      get(head->id()).addParent(get(tail->id()));

      // Defining input / output nodes
      if (tail->elt_type() == PRMClassElement< GUM_SCALAR >::prm_slotchain) {
        PRMSlotChain< GUM_SCALAR >* sc = static_cast< PRMSlotChain< GUM_SCALAR >* >(tail);
        this->setInputNode(*head, true);
        sc->end().setOutputNode(sc->end().get(sc->lastElt().safeName()), true);
      }
    }

aggregates()

template<typename GUM_SCALAR >

INLINE const Set< PRMAggregate< GUM_SCALAR > *> & gum::prm::PRMClass< GUM_SCALAR >::aggregates

(

)

const

Returns the set of PRMAggregate<GUM_SCALAR> of this Class<GUM_SCALAR>.

Returns

Returns the set of PRMAggregate<GUM_SCALAR> of this Class<GUM_SCALAR>.

Definition at line 1078 of file PRMClass_tpl.h.

                                                                                              {
      return _aggregates_;
    }

attributes()

template<typename GUM_SCALAR >

INLINE const Set< PRMAttribute< GUM_SCALAR > *> & gum::prm::PRMClass< GUM_SCALAR >::attributes

(

)

const

Returns the set of PRMAttribute<GUM_SCALAR> of this Class<GUM_SCALAR>.

Returns

Returns the set of PRMAttribute<GUM_SCALAR> of this Class<GUM_SCALAR>.

Definition at line 1016 of file PRMClass_tpl.h.

                                                                                              {
      return _attributes_;
    }

belongsTo()

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMClassElementContainer< GUM_SCALAR >::belongsTo ( const PRMClassElement< GUM_SCALAR > &  elt ) const

virtualinherited

Returns true if elt belongs to this PRMClassElementContainer.

Parameters

elt	A PRMClassElement<GUM_SCALAR>.

Returns

true if elt beglons to this PRMClassElementContainer.

Definition at line 170 of file PRMClassElementContainer_tpl.h.

                                                       {
      try {
        return &elt == &(get(elt.safeName()));
      } catch (NotFound&) { return false; }
    }

completeInheritance()

template<typename GUM_SCALAR >

void gum::prm::PRMClass< GUM_SCALAR >::completeInheritance

(

const std::string &

attr

)

Definition at line 278 of file PRMClass_tpl.h.

                                                                          {
      if (_superClass_) {
        auto& elt = this->get(name);
        if (!(PRMClassElement< GUM_SCALAR >::isAttribute(elt)
              || PRMClassElement< GUM_SCALAR >::isAggregate(elt))) {
          GUM_ERROR(OperationNotAllowed, "you can only complete inheritance for attributes")
        }

        for (const auto& prnt: super().containerDag().parents(elt.id())) {
          this->addArc(super().get(prnt).safeName(), elt.safeName());
        }

        if (PRMClassElement< GUM_SCALAR >::isAttribute(elt)) {
          auto& attr       = static_cast< PRMAttribute< GUM_SCALAR >& >(elt);
          auto& super_attr = static_cast< const PRMAttribute< GUM_SCALAR >& >(super().get(name));
          attr.copyCpf(*_bijection_, super_attr);
        }
      }
    }

containerDag()

template<typename GUM_SCALAR >

INLINE const DAG & gum::prm::PRMClassElementContainer< GUM_SCALAR >::containerDag ( ) const

virtualinherited

Returns the gum::DAG of this PRMClassElementContainer.

Be very careful when using NodeId with PRMClassElement<GUM_SCALAR>: there is no guarantee that an inherited PRMClassElement<GUM_SCALAR> will have the same NodeId than its superclass counterpart.

When dealing with different classes and interfaces ALWAYS use safe-name as identifier.

Returns

the DAG of this PRMClassElementContainer.

Definition at line 178 of file PRMClassElementContainer_tpl.h.

                                                                                 {
      return dag_();
    }

copyIOFlags_()

template<typename GUM_SCALAR>

void gum::prm::PRMClassElementContainer< GUM_SCALAR >::copyIOFlags_ ( const PRMClassElementContainer< GUM_SCALAR > &  c )

protectedvirtualinherited

Copy the IO Flags of c in this PRMClassElementContainer.

Parameters

c	A PRMClassElementContainer.

Definition at line 36 of file PRMClassElementContainer_tpl.h.

                                                        {
      for (const auto& flag: c._IOFlags_)
        setIOFlag_(get(flag.first), flag.second);
    }

dag_() [1/2]

template<typename GUM_SCALAR >

INLINE const DAG & gum::prm::PRMClass< GUM_SCALAR >::dag_ ( ) const

protectedvirtual

returns a constant reference over this interface's dag.

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

Definition at line 969 of file PRMClass_tpl.h.

                                                         {
      return _dag_;
    }

dag_() [2/2]

template<typename GUM_SCALAR >

INLINE DAG & gum::prm::PRMClass< GUM_SCALAR >::dag_ ( )

protectedvirtual

Returns a non constant reference over this PRMInterface<GUM_SCALAR>'s DAG.

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

Definition at line 974 of file PRMClass_tpl.h.

                                             {
      return _dag_;
    }

enum2str()

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

inlinestaticinherited

Returns the string representation of a PRMObject.

Definition at line 83 of file PRMObject.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";
        }
      }

exists() [1/2]

template<typename GUM_SCALAR >

INLINE bool gum::prm::PRMClassElementContainer< GUM_SCALAR >::exists ( const std::string &  name ) const

virtualinherited

Returns true if a member with the given name exists in this PRMClassElementContainer or in the PRMClassElementContainer hierarchy.

Definition at line 162 of file PRMClassElementContainer_tpl.h.

                                                                                          {
      try {
        get(name);
        return true;
      } catch (NotFound&) { return false; }
    }

exists() [2/2]

template<typename GUM_SCALAR >

INLINE bool gum::prm::PRMClassElementContainer< GUM_SCALAR >::exists ( NodeId  id ) const

virtualinherited

Returns true if a member with the given id exists in this PRMClassElementContainer or in the PRMClassElementContainer hierarchy.

Parameters

id

A NodeId.

Returns

true if id matches a PRMClassElement<GUM_SCALAR>.

Definition at line 157 of file PRMClassElementContainer_tpl.h.

                                                                              {
      return containerDag().exists(id);
    }

extensions()

template<typename GUM_SCALAR >

INLINE const Set< PRMClass< GUM_SCALAR > *> & gum::prm::PRMClass< GUM_SCALAR >::extensions

(

)

const

Returns the set of Class<GUM_SCALAR> which are direct sub-Class<GUM_SCALAR> of this Class<GUM_SCALAR>.

Definition at line 1181 of file PRMClass_tpl.h.

                                                                                          {
      return _extensions_;
    }

findAllSubtypes_()

template<typename GUM_SCALAR>

void gum::prm::PRMClass< GUM_SCALAR >::findAllSubtypes_ ( Set< PRMClassElementContainer< GUM_SCALAR > * > &  set )

protectedvirtual

Fills set with all the subtypes of this Class<GUM_SCALAR>.

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

Definition at line 923 of file PRMClass_tpl.h.

                                                            {
      for (auto ext: _extensions_) {
        set.insert(ext);
        ext->findAllSubtypes_(set);
      }
    }

get() [1/4]

template<typename GUM_SCALAR >

INLINE PRMClassElement< GUM_SCALAR > & gum::prm::PRMClass< GUM_SCALAR >::get ( NodeId  id )

virtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(NodeId).

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

Definition at line 979 of file PRMClass_tpl.h.

                                                                               {
      try {
        return *(_nodeIdMap_[id]);
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "no ClassElement<GUM_SCALAR> with the given NodeId")
      }
    }

get() [2/4]

template<typename GUM_SCALAR >

INLINE const PRMClassElement< GUM_SCALAR > & gum::prm::PRMClass< GUM_SCALAR >::get ( NodeId  id ) const

virtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(NodeId).

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

Definition at line 988 of file PRMClass_tpl.h.

                                                                                           {
      try {
        return *(_nodeIdMap_[id]);
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "no ClassElement<GUM_SCALAR> with the given NodeId (" << id << ")");
      }
    }

get() [3/4]

template<typename GUM_SCALAR >

INLINE PRMClassElement< GUM_SCALAR > & gum::prm::PRMClass< GUM_SCALAR >::get ( const std::string &  name )

virtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(const std::string&).

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

Definition at line 997 of file PRMClass_tpl.h.

                                                                                           {
      try {
        return *(_nameMap_[name]);
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "no ClassElement<GUM_SCALAR> with the given name (" << name << ")");
      }
    }

get() [4/4]

template<typename GUM_SCALAR >

INLINE const PRMClassElement< GUM_SCALAR > & gum::prm::PRMClass< GUM_SCALAR >::get ( const std::string &  name ) const

virtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(const std::string&).

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

Definition at line 1007 of file PRMClass_tpl.h.

                                                                        {
      try {
        return *(_nameMap_[name]);
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "no ClassElement<GUM_SCALAR> with the given name (" << name << ")");
      }
    }

getIOFlag_() [1/2]

template<typename GUM_SCALAR>

INLINE std::pair< bool, bool > & gum::prm::PRMClassElementContainer< GUM_SCALAR >::getIOFlag_ ( const PRMClassElement< GUM_SCALAR > &  elt )

protectedvirtualinherited

Returns the IO flags of a PRMClassElement<GUM_SCALAR>.

Parameters

elt	The PRMClassElement<GUM_SCALAR>.

Returns

elt's IO flags.

Exceptions

NotFound

Raised if elt does not have any IO flags.

Definition at line 128 of file PRMClassElementContainer_tpl.h.

                                                 {
      try {
        return _IOFlags_[elt.safeName()];
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "this ClassElement<GUM_SCALAR> does not have any IO flags")
      }
    }

getIOFlag_() [2/2]

template<typename GUM_SCALAR>

INLINE const std::pair< bool, bool > & gum::prm::PRMClassElementContainer< GUM_SCALAR >::getIOFlag_ ( const PRMClassElement< GUM_SCALAR > &  elt ) const

protectedvirtualinherited

Returns the IO flags of a PRMClassElement<GUM_SCALAR>.

Parameters

elt	The PRMClassElement<GUM_SCALAR>.

Returns

elt's IO flags.

Exceptions

NotFound

Raised if elt does not have any IO flags.

Definition at line 138 of file PRMClassElementContainer_tpl.h.

                                                       {
      try {
        return _IOFlags_[elt.safeName()];
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "this ClassElement<GUM_SCALAR> does not have any IO flags")
      }
    }

implements()

template<typename GUM_SCALAR >

INLINE const Set< PRMInterface< GUM_SCALAR > *> & gum::prm::PRMClass< GUM_SCALAR >::implements

(

)

const

Returns the Set of PRMInterface<GUM_SCALAR> implemented by this Class<GUM_SCALAR>.

Returns

Returns the Set of PRMInterface<GUM_SCALAR> implemented by this Class<GUM_SCALAR>.

Exceptions

NotFound

Raised if this Class<GUM_SCALAR> doesn't implement any PRMInterface<GUM_SCALAR>.

Definition at line 1103 of file PRMClass_tpl.h.

                                                                                              {
      if (_implements_) {
        return *_implements_;
      } else {
        GUM_ERROR(NotFound, "this Class does not implement any Interface<GUM_SCALAR>")
      }
    }

inheritAggregates()

template<typename GUM_SCALAR >

void gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates

(

)

Definition at line 219 of file PRMClass_tpl.h.

                                                   {
      if (_superClass_) {
        for (const auto c_agg: _superClass_->_aggregates_) {
          PRMAggregate< GUM_SCALAR >* agg = nullptr;

          try {
            agg = new PRMAggregate< GUM_SCALAR >(c_agg->name(),
                                                 c_agg->agg_type(),
                                                 c_agg->type(),
                                                 c_agg->label());
          } catch (OperationNotAllowed&) {
            agg = new PRMAggregate< GUM_SCALAR >(c_agg->name(), c_agg->agg_type(), c_agg->type());
            agg->sharedLabel(c_agg->sharedLabel());
            agg->setLabel(c_agg->labelValue());
          }

          _bijection_->insert(&(c_agg->type().variable()), &(agg->type().variable()));
          agg->setId(c_agg->id());
          _dag_.addNodeWithId(agg->id());
          _nodeIdMap_.insert(agg->id(), agg);
          _aggregates_.insert(agg);

          if (_superClass_->_nameMap_[c_agg->name()] == _superClass_->_nameMap_[c_agg->safeName()])
            _nameMap_.insert(agg->name(), agg);

          _nameMap_.insert(agg->safeName(), agg);
        }
      }
    }

inheritAttributes()

template<typename GUM_SCALAR >

void gum::prm::PRMClass< GUM_SCALAR >::inheritAttributes

(

)

Definition at line 191 of file PRMClass_tpl.h.

                                                   {
      if (_superClass_) {
        for (const auto c_attr: _superClass_->_attributes_) {
          // using multiDimSparse to prevent unecessary memory allocation for
          // large arrays (the potentials are copied latter)
          auto attr = c_attr->newFactory(*this);

          _bijection_->insert(&(c_attr->type().variable()), &(attr->type().variable()));
          attr->setId(c_attr->id());
          try {
            _dag_.addNodeWithId(attr->id());
          } catch (gum::Exception&) {
            // Node reserved by an interface
          }
          _nodeIdMap_.insert(attr->id(), attr);
          _attributes_.insert(attr);

          if (_superClass_->_nameMap_[c_attr->name()]
              == _superClass_->_nameMap_[c_attr->safeName()]) {
            _nameMap_.insert(attr->name(), attr);
          }

          _nameMap_.insert(attr->safeName(), attr);
        }
      }
    }

inheritParameters()

template<typename GUM_SCALAR >

void gum::prm::PRMClass< GUM_SCALAR >::inheritParameters

(

)

Definition at line 172 of file PRMClass_tpl.h.

                                                   {
      if (_superClass_) {
        // Copying parameters
        for (const auto c_param: _superClass_->_parameters_) {
          auto param = new PRMParameter< GUM_SCALAR >(c_param->name(),
                                                      c_param->valueType(),
                                                      c_param->value());

          _parameters_.insert(param);

          param->setId(c_param->id());
          _dag_.addNodeWithId(param->id());
          _nodeIdMap_.insert(param->id(), param);
          _nameMap_.insert(param->name(), param);
        }
      }
    }

inheritReferenceSlots()

template<typename GUM_SCALAR >

void gum::prm::PRMClass< GUM_SCALAR >::inheritReferenceSlots

(

)

Definition at line 146 of file PRMClass_tpl.h.

                                                       {
      if (_superClass_) {
        // Copying reference slots
        for (const auto c_refslot: _superClass_->_referenceSlots_) {
          auto ref = new PRMReferenceSlot< GUM_SCALAR >(
             c_refslot->name(),
             const_cast< PRMClassElementContainer< GUM_SCALAR >& >(c_refslot->slotType()),
             c_refslot->isArray());

          ref->setId(c_refslot->id());
          // Not reserved by an interface
          if (!_dag_.existsNode(ref->id())) { _dag_.addNodeWithId(ref->id()); }
          _nodeIdMap_.insert(ref->id(), ref);
          _referenceSlots_.insert(ref);

          if (_superClass_->_nameMap_[c_refslot->name()]
              == _superClass_->_nameMap_[c_refslot->safeName()]) {
            _nameMap_.insert(ref->name(), ref);
          }

          _nameMap_.insert(ref->safeName(), ref);
        }
      }
    }

inheritSlotChains()

template<typename GUM_SCALAR >

void gum::prm::PRMClass< GUM_SCALAR >::inheritSlotChains

(

)

Definition at line 250 of file PRMClass_tpl.h.

                                                   {
      if (_superClass_) {
        // Copying slot chains
        for (const auto c_sc: _superClass_->_slotChains_) {
          // Because of aggregators, some slotchains may exists already
          if (!(_nameMap_.exists(c_sc->name()) && _nameMap_.exists(c_sc->safeName()))) {
            // We just need to change the first PRMReferenceSlot<GUM_SCALAR> in
            // the
            // chain
            auto chain = c_sc->chain();

            chain.setAtPos(0, _nameMap_[c_sc->chain().front()->name()]);

            auto sc = new PRMSlotChain< GUM_SCALAR >(c_sc->name(), chain);
            _bijection_->insert(&(c_sc->type().variable()), &(sc->type().variable()));
            sc->setId(c_sc->id());
            _dag_.addNodeWithId(sc->id());
            _nodeIdMap_.insert(sc->id(), sc);
            _slotChains_.insert(sc);

            if (!_nameMap_.exists(sc->name())) { _nameMap_.insert(sc->name(), sc); }
            if (!_nameMap_.exists(sc->safeName())) { _nameMap_.insert(sc->safeName(), sc); }
          }
        }
      }
    }

initializeInheritance()

template<typename GUM_SCALAR >

void gum::prm::PRMClass< GUM_SCALAR >::initializeInheritance

(

)

Definition at line 128 of file PRMClass_tpl.h.

                                                       {
      if (_superClass_) {
        _superClass_->_addExtension_(this);
        // Adding implemented interfaces, if any
        if (_superClass_->_implements_) {
          if (!_implements_) {
            _implements_ = new Set< PRMInterface< GUM_SCALAR >* >(*(_superClass_->_implements_));
          } else {
            for (auto i: *(_superClass_->_implements_)) {
              _implements_->insert(i);
            }
          }
        }
      }
      if (_implements_) { _implementInterfaces_(true); }
    }

isCastDescendant()

template<typename GUM_SCALAR >

INLINE bool gum::prm::PRMClass< GUM_SCALAR >::isCastDescendant

(

const std::string &

safe_name

)

const

Return true if the attribute named safe_name is a cast descendant.

Cast descendant are automatically added PRMAttribute<GUM_SCALAR> for type casting.

Parameters

safe_name

The safe name of an PRMAttribute<GUM_SCALAR> of this class.

Returns

true if safe_name is a cast descendant.

Exceptions

NotFound

Raised if safe_name does not name an PRMAttribute<GUM_SCALAR> in this Class<GUM_SCALAR>.

Definition at line 1191 of file PRMClass_tpl.h.

                                                                                         {
      const PRMClassElement< GUM_SCALAR >& elt = get(safe_name);

      try {
        return elt.type().name() == get(elt.name()).type().name();
      } catch (OperationNotAllowed&) { GUM_ERROR(NotFound, "no attribute with the given name") }
    }

isClass()

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

inlinestaticinherited

Returns true if obj_ptr is of type Class.

Definition at line 109 of file PRMObject.h.

References gum::prm::PRMObject::PRMObject().

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

Here is the call graph for this function:

isInnerNode()

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMClassElementContainer< GUM_SCALAR >::isInnerNode ( const PRMClassElement< GUM_SCALAR > &  elt ) const

virtualinherited

Returns true if the node is an inner node.

PRMAttribute or PRMAggregate can either be input, output, both or internal nodes.

By defaut, attributes and aggregates are inner nodes.

Parameters

elt	A PRMClassElement<GUM_SCALAR>.

Returns

true if elt is an inner node.

Exceptions

NotFound	Raised if NodeId does'nt match any PRMClassElement<GUM_SCALAR> in this.
WrongClassElement	Raised if NodeId is neither an PRMAttribute nor an PRMAggregate.

Definition at line 114 of file PRMClassElementContainer_tpl.h.

                                                       {
      try {
        return !(getIOFlag_(elt).first || getIOFlag_(elt).second);
      } catch (NotFound&) { return true; }
    }

isInputNode()

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMClassElementContainer< GUM_SCALAR >::isInputNode ( const PRMClassElement< GUM_SCALAR > &  elt ) const

virtualinherited

Returns true if the node is an input node.

PRMAttribute or PRMAggregate can either be input, output, both or internal nodes.

By defaut, attributes and aggregates are inner nodes.

Parameters

elt	A PRMClassElement<GUM_SCALAR>.

Returns

Returns true if id is an input node.

Definition at line 70 of file PRMClassElementContainer_tpl.h.

                                                       {
      try {
        return getIOFlag_(elt).first;
      } catch (NotFound&) { return false; }
    }

isInstance()

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

inlinestaticinherited

Returns true if obj_ptr is of type PRMInstance.

Definition at line 117 of file PRMObject.h.

References gum::prm::PRMObject::PRMObject().

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

Here is the call graph for this function:

isInterface()

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

inlinestaticinherited

Returns true if obj_ptr is of type PRMInterface.

Definition at line 112 of file PRMObject.h.

References gum::prm::PRMObject::PRMObject().

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

Here is the call graph for this function:

isOutputNode()

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMClass< GUM_SCALAR >::isOutputNode ( const PRMClassElement< GUM_SCALAR > &  elt ) const

virtual

Returns true if elt is an output node.

Parameters

elt	A node of this class.

Returns

Returns true if elt is an output node.

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

Definition at line 1201 of file PRMClass_tpl.h.

                                                                                          {
      try {
        if (!this->getIOFlag_(elt).second) {
          if (_implements_) {
            for (auto i: *_implements_) {
              if (i->isOutputNode(elt)) { return true; }
            }
          }

          if (_superClass_ && (_superClass_->isOutputNode(elt))) { return true; }

        } else {
          return true;
        }
      } catch (NotFound&) {}
      return false;
    }

isSubTypeOf()

template<typename GUM_SCALAR>

bool gum::prm::PRMClass< GUM_SCALAR >::isSubTypeOf ( const PRMClassElementContainer< GUM_SCALAR > &  cec ) const

virtual

Test if this Class<GUM_SCALAR> is a subclass of cec.

If cec is a Class<GUM_SCALAR> then this Class<GUM_SCALAR> is a subclass of cec if they are equal or there exists a superclass of this Class<GUM_SCALAR> which is equal to cec.

If cec is an PRMInterface<GUM_SCALAR> then this Class<GUM_SCALAR> is a subclass of cec if it implements cec or if there exists a superclass of this Class<GUM_SCALAR> which implements cec.

Parameters

cec	The PRMClassElementContainer<GUM_SCALAR> for which we determine if this Class<GUM_SCALAR> is a subclass of it.

Returns

Returns true if this Class<GUM_SCALAR> is a subclass of cec.

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

Definition at line 428 of file PRMClass_tpl.h.

                                                                {
      switch (cec.obj_type()) {
        case PRMObject::prm_type::CLASS: {
          const PRMClass< GUM_SCALAR >* current = this;

          while (current != 0) {
            if (current == &(cec)) return true;

            current = current->_superClass_;
          }

          return false;
        }

        case PRMObject::prm_type::PRM_INTERFACE: {
          if (_implements_ != nullptr) {
            const PRMInterface< GUM_SCALAR >& i
               = static_cast< const PRMInterface< GUM_SCALAR >& >(cec);

            if (_implements_->exists(const_cast< PRMInterface< GUM_SCALAR >* >(&i))) return true;

            for (const auto impl: *_implements_)
              if (impl->isSubTypeOf(i)) return true;
          }

          return false;
        }

        default: {
          GUM_ERROR(FatalError, "unknown ClassElementContainer<GUM_SCALAR>")
        }
      }
    }

isSuperTypeOf()

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMClassElementContainer< GUM_SCALAR >::isSuperTypeOf ( const PRMClassElementContainer< GUM_SCALAR > &  cec ) const

virtualinherited

Test if this PRMClassElementContainer is a super type of cec.

This returns cec.isSubTypeOf(*this).

Parameters

cec

Returns

return true if this PRMClassElementContainer is a super type of cec.

Definition at line 122 of file PRMClassElementContainer_tpl.h.

                                                                {
      return cec.isSubTypeOf(*this);
    }

LEFT_CAST()

static std::string gum::prm::PRMObject::LEFT_CAST ( )

inlinestaticinherited

Enumeration of the different types of objects handled by a PRM.

The "all" type is used to tell that we want any kind of PRMType (useful with iterators for example). No PRMObject will ever have "all" as type.

Definition at line 79 of file PRMObject.h.

{ return "("; }

name() [1/2]

INLINE const std::string & gum::prm::PRMObject::name ( ) const

inherited

Returns the name of this object.

Definition at line 34 of file PRMObject_inl.h.

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

{ return _name_; }

Here is the call graph for this function:

name() [2/2]

INLINE void gum::prm::PRMObject::name ( const std::string &  name )

inherited

Change the name of the PRM Object.

Warning

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

Definition at line 38 of file PRMObject_inl.h.

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

{ _name_ = name; }

Here is the call graph for this function:

obj_type()

template<typename GUM_SCALAR >

INLINE PRMObject::prm_type gum::prm::PRMClass< GUM_SCALAR >::obj_type ( ) const

virtual

Implementation of pure virtual method of PRMObject.

Implements gum::prm::PRMObject.

Definition at line 964 of file PRMClass_tpl.h.

                                                                             {
      return PRMObject::prm_type::CLASS;
    }

operator!=()

INLINE bool gum::prm::PRMObject::operator!= ( const PRMObject &  obj ) const

inherited

To PRMObject are equal if they have the same name (which is unique).

Definition at line 46 of file PRMObject_inl.h.

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

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

Here is the call graph for this function:

operator=() [1/2]

template<typename GUM_SCALAR>

PRMClass< GUM_SCALAR >& gum::prm::PRMClass< GUM_SCALAR >::operator= ( const PRMClass< GUM_SCALAR > &  source )

delete

Copy operator. Don't use it.

operator=() [2/2]

template<typename GUM_SCALAR>

PRMClass< GUM_SCALAR >& gum::prm::PRMClass< GUM_SCALAR >::operator= ( const PRMClass< GUM_SCALAR > &&  source )

delete

Move operator. Don't use it.

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

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

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

Here is the call graph for this function:

operator[]() [1/4]

template<typename GUM_SCALAR >

INLINE PRMClassElement< GUM_SCALAR > & gum::prm::PRMClass< GUM_SCALAR >::operator[] ( NodeId  id )

virtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](NodeId).

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

Definition at line 1112 of file PRMClass_tpl.h.

                                                                                      {
      return get(id);
    }

operator[]() [2/4]

template<typename GUM_SCALAR >

INLINE const PRMClassElement< GUM_SCALAR > & gum::prm::PRMClass< GUM_SCALAR >::operator[] ( NodeId  id ) const

virtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](NodeId).

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

Definition at line 1118 of file PRMClass_tpl.h.

                                                         {
      return get(id);
    }

operator[]() [3/4]

template<typename GUM_SCALAR >

INLINE PRMClassElement< GUM_SCALAR > & gum::prm::PRMClass< GUM_SCALAR >::operator[] ( const std::string &  name )

virtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](const std::string&).

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

Definition at line 1124 of file PRMClass_tpl.h.

                                                               {
      return get(name);
    }

operator[]() [4/4]

template<typename GUM_SCALAR >

INLINE const PRMClassElement< GUM_SCALAR > & gum::prm::PRMClass< GUM_SCALAR >::operator[] ( const std::string &  name ) const

virtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](const std::string&).

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

Definition at line 1130 of file PRMClass_tpl.h.

                                                                     {
      return get(name);
    }

overload()

template<typename GUM_SCALAR>

NodeId gum::prm::PRMClass< GUM_SCALAR >::overload ( PRMClassElement< GUM_SCALAR > *  elt )

virtual

See gum::prm::overload(PRMClassElement<GUM_SCALAR>*).

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

Definition at line 703 of file PRMClass_tpl.h.

                                                                                     {
      try {
        if (!super().exists(overloader->name())) {
          GUM_ERROR(OperationNotAllowed, "found no ClassElement<GUM_SCALAR> to overload")
        }
      } catch (NotFound&) {
        GUM_ERROR(OperationNotAllowed, "overload is possible only with subclasses")
      }

      PRMClassElement< GUM_SCALAR >* overloaded = _nameMap_[overloader->name()];
      if (overloaded == overloader) {
        GUM_ERROR(DuplicateElement, "dupplicate ClassElement " << overloader->name())
      }
      // Checking overload legality
      if (!_checkOverloadLegality_(overloaded, overloader)) {
        GUM_ERROR(OperationNotAllowed, "illegal overload")
      }

      switch (overloader->elt_type()) {
        case PRMClassElement< GUM_SCALAR >::prm_attribute: {
          auto overloader_attr = static_cast< PRMAttribute< GUM_SCALAR >* >(overloader);
          auto overloaded_attr = static_cast< PRMAttribute< GUM_SCALAR >* >(overloaded);
          _overloadAttribute_(overloader_attr, overloaded_attr);
          _addIOInterfaceFlags_(overloader);
          break;
        }

        case PRMClassElement< GUM_SCALAR >::prm_aggregate: {
          _overloadAggregate_(static_cast< PRMAggregate< GUM_SCALAR >* >(overloader), overloaded);
          _addIOInterfaceFlags_(overloader);
          break;
        }

        case PRMClassElement< GUM_SCALAR >::prm_refslot: {
          //  _checkOverloadLegality_ guaranties that overloaded is a
          // PRMReferenceSlot<GUM_SCALAR>
          auto overloader_ref = static_cast< PRMReferenceSlot< GUM_SCALAR >* >(overloader);
          auto overloaded_ref = static_cast< PRMReferenceSlot< GUM_SCALAR >* >(overloaded);
          _overloadReference_(overloader_ref, overloaded_ref);
          break;
        }

        case PRMClassElement< GUM_SCALAR >::prm_slotchain: {
          GUM_ERROR(OperationNotAllowed, "SlotChain<GUM_SCALAR> can not be overloaded")
          break;
        }

        case PRMClassElement< GUM_SCALAR >::prm_parameter: {
          auto overloaded_param = static_cast< PRMParameter< GUM_SCALAR >* >(overloaded);
          auto overloader_param = static_cast< PRMParameter< GUM_SCALAR >* >(overloader);
          _overloadParameter_(overloader_param, overloaded_param);
          break;
        }
        default: {
          GUM_ERROR(OperationNotAllowed, "unknown ClassElement<GUM_SCALAR> type")
        }
      }

      return overloader->id();
    }

parameters()

template<typename GUM_SCALAR >

INLINE const Set< PRMParameter< GUM_SCALAR > *> & gum::prm::PRMClass< GUM_SCALAR >::parameters

(

)

const

Returns the set of parameters of this Class<GUM_SCALAR>.

Returns

Returns the set of parameters of this Class<GUM_SCALAR>.

Definition at line 1021 of file PRMClass_tpl.h.

                                                                                              {
      return _parameters_;
    }

referenceSlots()

template<typename GUM_SCALAR >

INLINE const Set< PRMReferenceSlot< GUM_SCALAR > *> & gum::prm::PRMClass< GUM_SCALAR >::referenceSlots

(

)

const

Returns the set of PRMReferenceSlot<GUM_SCALAR> of this Class<GUM_SCALAR>.

Returns

Returns the set of PRMReferenceSlot<GUM_SCALAR> of this Class<GUM_SCALAR>.

Definition at line 1084 of file PRMClass_tpl.h.

                                                              {
      return _referenceSlots_;
    }

RIGHT_CAST()

static std::string gum::prm::PRMObject::RIGHT_CAST ( )

inlinestaticinherited

Enumeration of the different types of objects handled by a PRM.

The "all" type is used to tell that we want any kind of PRMType (useful with iterators for example). No PRMObject will ever have "all" as type.

Definition at line 80 of file PRMObject.h.

{ return ")"; }

scope()

template<typename GUM_SCALAR >

INLINE HashTable< std::string, const PRMParameter< GUM_SCALAR > *> gum::prm::PRMClass< GUM_SCALAR >::scope

(

)

const

Returns all the parameters in the scope of this class.

&return all the parameters in the scope of this class.

Definition at line 1039 of file PRMClass_tpl.h.

                                               {
      HashTable< std::string, const PRMParameter< GUM_SCALAR >* > params;

      for (const auto p: parameters()) {
        params.insert(p->name(), p);
      }

      std::queue< ParamScopeData< GUM_SCALAR > > queue;

      for (const auto ref: referenceSlots()) {
        if (PRMObject::isClass(ref->slotType())) {
          queue.push(ParamScopeData< GUM_SCALAR >("", *ref, 1));
        }
      }

      while (!queue.empty()) {
        auto data = queue.front();
        queue.pop();

        if (data.depth < 5) {
          for (const auto p: data.c->parameters()) {
            params.insert(data.prefix + p->name(), p);
          }

          for (const auto ref: data.c->referenceSlots()) {
            if (PRMObject::isClass(ref->slotType())) {
              queue.push(ParamScopeData< GUM_SCALAR >(data.prefix, *ref, data.depth + 1));
            }
          }
        } else {
          // @todo depth>5 is a workaround. Cycle detection is needed here !
          GUM_ERROR(FatalError, "Depth limit reached when looking up parameters")
        }
      }

      return params;
    }

setInputNode()

template<typename GUM_SCALAR>

INLINE void gum::prm::PRMClassElementContainer< GUM_SCALAR >::setInputNode ( const PRMClassElement< GUM_SCALAR > &  elt, bool  b  )

virtualinherited

Set the input flag value of id at b.

PRMAttribute or PRMAggregate can either be input, output, both or internal nodes.

By defaut, attributes and aggregates are inner nodes.

Parameters

elt	A PRMClassElement<GUM_SCALAR>.
b	The flag value.

Exceptions

NotFound	Raised if id does'nt match any PRMClassElement<GUM_SCALAR> in this.
WrongClassElement	Raised if NodeId is neither an PRMAttribute nor an PRMAggregate.

Definition at line 78 of file PRMClassElementContainer_tpl.h.

                                               {
      if (!exists(elt.safeName())) {
        GUM_ERROR(NotFound, ": <" + elt.safeName() + "> is not in <" + name() + ">")
      } else if (PRMClassElement< GUM_SCALAR >::isAttribute(elt)
                 || PRMClassElement< GUM_SCALAR >::isAggregate(elt)) {
        try {
          getIOFlag_(elt).first = b;
        } catch (NotFound&) { setIOFlag_(elt, std::make_pair(b, false)); }
      } else {
        GUM_ERROR(WrongClassElement, "given id is not an PRMAttribute or an PRMAggregate")
      }
    }

setIOFlag_()

template<typename GUM_SCALAR>

INLINE void gum::prm::PRMClassElementContainer< GUM_SCALAR >::setIOFlag_ ( const PRMClassElement< GUM_SCALAR > &  elt, const std::pair< bool, bool > &  flags  )

protectedvirtualinherited

Defines the IO flags of a PRMClassElement<GUM_SCALAR>.

Parameters

elt	The PRMClassElement<GUM_SCALAR>.
flags	The IO flags of elt. Overwrite any existing flags.

Returns

elt's IO flags.

Exceptions

NotFound

Raised if elt does not have any IO flags.

Definition at line 149 of file PRMClassElementContainer_tpl.h.

                                                                                              {
      try {
        _IOFlags_[elt.safeName()] = flags;
      } catch (NotFound&) { _IOFlags_.insert(elt.safeName(), flags); }
    }

setOutputNode()

template<typename GUM_SCALAR>

INLINE void gum::prm::PRMClassElementContainer< GUM_SCALAR >::setOutputNode ( const PRMClassElement< GUM_SCALAR > &  elt, bool  b  )

virtualinherited

Set the output flag value of id at b.

PRMAttribute or PRMAggregate can either be input, output, both or internal nodes.

By defaut, attributes and aggregates are inner nodes.

Parameters

elt	A PRMClassElement<GUM_SCALAR>.
b	The flag value.

Exceptions

NotFound	Raised if id does'nt match any PRMClassElement<GUM_SCALAR> in this.
WrongClassElement	Raised if NodeId is neither an PRMAttribute nor an PRMAggregate.

Definition at line 94 of file PRMClassElementContainer_tpl.h.

                                               {
      if (!exists(elt.safeName())) {
        GUM_ERROR(NotFound, "<" + elt.safeName() + "> is not in <" + name() + ">")
      } else if (PRMClassElement< GUM_SCALAR >::isAttribute(elt)
                 || PRMClassElement< GUM_SCALAR >::isAggregate(elt)) {
        try {
          getIOFlag_(elt).second = b;
        } catch (NotFound&) { setIOFlag_(elt, std::make_pair(false, b)); }

        if (b) { updateDescendants_(elt); }
      } else {
        GUM_ERROR(WrongClassElement,
                  "given ClassElement<GUM_SCALAR> is not an "
                  "PRMAttribute or an PRMAggregate");
      }
    }

slotChains()

template<typename GUM_SCALAR >

INLINE const Set< PRMSlotChain< GUM_SCALAR > *> & gum::prm::PRMClass< GUM_SCALAR >::slotChains

(

)

const

Returns the set of PRMSlotChain<GUM_SCALAR> of this Class<GUM_SCALAR>.

Returns

Returns the set of PRMSlotChain<GUM_SCALAR> of this Class<GUM_SCALAR>.

Definition at line 1089 of file PRMClass_tpl.h.

                                                                                              {
      return _slotChains_;
    }

super()

template<typename GUM_SCALAR >

INLINE const PRMClass< GUM_SCALAR > & gum::prm::PRMClass< GUM_SCALAR >::super

(

)

const

Returns the super Class<GUM_SCALAR> of this Class<GUM_SCALAR>.

Returns

Returns the super Class<GUM_SCALAR> of this Class<GUM_SCALAR>.

Exceptions

NotFound

Raised if this has no super Class<GUM_SCALAR>.

Definition at line 1094 of file PRMClass_tpl.h.

                                                                             {
      if (_superClass_) {
        return *_superClass_;
      } else {
        GUM_ERROR(NotFound, "this Class is not a subclass")
      }
    }

updateDescendants_()

template<typename GUM_SCALAR>

void gum::prm::PRMClass< GUM_SCALAR >::updateDescendants_ ( const PRMClassElement< GUM_SCALAR > &  elt )

protectedvirtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>(const PRMClassElement<GUM_SCALAR>&).

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

Definition at line 954 of file PRMClass_tpl.h.

                                                                                            {
      // for ( const auto ext :  _extensions_ ) {
      //  // We test to prevent unnecessary recursive call from iter
      //  if ( !ext->isOutputNode( elt ) ) {
      //    ext->setOutputNode( elt, true );
      //  }
      //}
    }

Friends And Related Function Documentation

PRMInterface< GUM_SCALAR >

template<typename GUM_SCALAR>

friend class PRMInterface< GUM_SCALAR >

friend

Definition at line 66 of file PRMClass.h.

Member Data Documentation

_aggregates_

template<typename GUM_SCALAR>

Set< PRMAggregate< GUM_SCALAR >* > gum::prm::PRMClass< GUM_SCALAR >::_aggregates_

private

The sequence of aggregate.

Definition at line 360 of file PRMClass.h.

_attributes_

template<typename GUM_SCALAR>

Set< PRMAttribute< GUM_SCALAR >* > gum::prm::PRMClass< GUM_SCALAR >::_attributes_

private

The sequence of PRMAttribute<GUM_SCALAR>s.

Definition at line 354 of file PRMClass.h.

_bijection_

template<typename GUM_SCALAR>

Bijection< const DiscreteVariable*, const DiscreteVariable* >* gum::prm::PRMClass< GUM_SCALAR >::_bijection_

private

The bijection between variables in super and variables in this The bijection's firsts are attributes in this and its seconds are attributes in c.

Definition at line 397 of file PRMClass.h.

_dag_

template<typename GUM_SCALAR>

DAG gum::prm::PRMClass< GUM_SCALAR >::_dag_

private

The dag representing dependencies between formal attributes and slots.

Definition at line 337 of file PRMClass.h.

_dummy_hashfunc_

template<typename GUM_SCALAR>

HashFunc< PRMClassElementContainer< GUM_SCALAR >* > gum::prm::PRMClass< GUM_SCALAR >::_dummy_hashfunc_

private

a dummy member used to fix a compilation issue in clang4

Definition at line 400 of file PRMClass.h.

_extensions_

template<typename GUM_SCALAR>

Set< PRMClass< GUM_SCALAR >* > gum::prm::PRMClass< GUM_SCALAR >::_extensions_

private

The set of Class<GUM_SCALAR> which are extension of this Class<GUM_SCALAR> (i.e. direct subtypes).

Definition at line 392 of file PRMClass.h.

_implements_

template<typename GUM_SCALAR>

Set< PRMInterface< GUM_SCALAR >* >* gum::prm::PRMClass< GUM_SCALAR >::_implements_

private

The Set of implemented interface of this.

Definition at line 388 of file PRMClass.h.

_nameMap_

template<typename GUM_SCALAR>

HashTable< std::string, PRMClassElement< GUM_SCALAR >* > gum::prm::PRMClass< GUM_SCALAR >::_nameMap_

private

Mapping between a member's name and itself. Used for fast access to a member given it's name.

Definition at line 351 of file PRMClass.h.

_nodeIdMap_

template<typename GUM_SCALAR>

NodeProperty< PRMClassElement< GUM_SCALAR >* > gum::prm::PRMClass< GUM_SCALAR >::_nodeIdMap_

private

Mapping between node's id and their name (being an attribute or a slot). Used for fast access to a member given it's node id.

Definition at line 341 of file PRMClass.h.

_parameters_

template<typename GUM_SCALAR>

Set< PRMParameter< GUM_SCALAR >* > gum::prm::PRMClass< GUM_SCALAR >::_parameters_

private

The Set of parameters in this Class<GUM_SCALAR>.

Definition at line 366 of file PRMClass.h.

_referenceSlots_

template<typename GUM_SCALAR>

Set< PRMReferenceSlot< GUM_SCALAR >* > gum::prm::PRMClass< GUM_SCALAR >::_referenceSlots_

private

The sequence of PRMReferenceSlot<GUM_SCALAR>.

Definition at line 357 of file PRMClass.h.

_slotChains_

template<typename GUM_SCALAR>

Set< PRMSlotChain< GUM_SCALAR >* > gum::prm::PRMClass< GUM_SCALAR >::_slotChains_

private

The set of gum::PRMSlotChain<GUM_SCALAR>s.

Definition at line 363 of file PRMClass.h.

_superClass_

template<typename GUM_SCALAR>

PRMClass< GUM_SCALAR >* gum::prm::PRMClass< GUM_SCALAR >::_superClass_

private

The alternate PRMClassElementContainer<GUM_SCALAR> searched for elements defined in this. Note that this is first searched for gum::PRMClassElement<GUM_SCALAR>.

Definition at line 385 of file PRMClass.h.

---

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

• agrum/PRM/elements/PRMClass.h
• agrum/PRM/elements/PRMClass_tpl.h