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

<agrum/PRM/elements/funcAttribute.h> More...

#include <PRMFuncAttribute.h>

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

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

Public Member Functions
	PRMFuncAttribute (const std::string &name, const PRMType &type, MultiDimImplementation< GUM_SCALAR > *impl=new MultiDimArray< GUM_SCALAR >())
	Constructor used by gum::Class. More...
virtual	~PRMFuncAttribute ()
	Destructor. More...
virtual void	addParent (const PRMClassElement< GUM_SCALAR > &elt)
	See gum::PRMClassElement::_addParent(). More...
virtual void	addChild (const PRMClassElement< GUM_SCALAR > &elt)
	See gum::PRMClassElement::_addChild(). More...
Getters & setters
virtual PRMAttribute< GUM_SCALAR > *	newFactory (const PRMClass< GUM_SCALAR > &c) const
	See gum::PRMClassElement::elt_type(). More...
virtual PRMAttribute< GUM_SCALAR > *	copy (Bijection< const DiscreteVariable *, const DiscreteVariable * > bij) const
	See gum::PRMClassElement::elt_type(). More...
virtual void	copyCpf (const Bijection< const DiscreteVariable *, const DiscreteVariable * > &bif, const PRMAttribute< GUM_SCALAR > &source)
	See gum::PRMClassElement::elt_type(). More...
virtual PRMClassElement< GUM_SCALAR >::ClassElementType	elt_type () const
	See gum::PRMClassElement::elt_type(). More...
virtual PRMType &	type ()
	See gum::PRMClassElement::type(). More...
virtual const PRMType &	type () const
	See gum::PRMClassElement::type(). More...
virtual const Potential< GUM_SCALAR > &	cpf () const
	See gum::PRMClassElement::cpf(). More...
virtual PRMAttribute< GUM_SCALAR > *	getCastDescendant () const
	See gum::PRMClassElement::elt_type(). More...
virtual void	setAsCastDescendant (PRMAttribute< GUM_SCALAR > *attr)
	See gum::PRMClassElement::elt_type(). More...
virtual void	becomeCastDescendant (PRMType &subtype)
	See gum::PRMClassElement::elt_type(). More...
virtual void	swap (const PRMType &old_type, const PRMType &new_type)
	Swap old_type with new_type in the PRMClassElement cpt. More...
Getters & setters
virtual void	overload (PRMAttribute< GUM_SCALAR > *source)
	Set this as overload of source (necessayr to preserver internal pointers for MultiDims). More...
Getters & setters
NodeId	id () const
	Returns the NodeId of this element in it's class DAG. More...
virtual void	setId (NodeId id)
	Used to assign the id of this element. More...
virtual PRMObject::prm_type	obj_type () const
Fast access to random variable's properties
const std::string &	safeName () const
	Returns the safe name of this PRMClassElement, if any. More...
virtual std::string	cast (const PRMType &t) const
	Returns the name of the cast descendant with PRMType t of this PRMClassElement. More...
Getters & setters.
const std::string &	name () const
	Returns the name of this object. More...
void	name (const std::string &name)
	Change the name of the PRM Object. More...
Operators
bool	operator== (const PRMObject &obj) const
	To PRMObject are equal if they have the same name (which is unique). More...
bool	operator!= (const PRMObject &obj) const
	To PRMObject are equal if they have the same name (which is unique). More...

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

Protected Member Functions
	PRMFuncAttribute (const PRMFuncAttribute< GUM_SCALAR > &source)
	Copy constructor. Don't use it. More...
PRMFuncAttribute< GUM_SCALAR > &	operator= (const PRMFuncAttribute< GUM_SCALAR > &from)
	Copy operator. Don't use it. More...
virtual void	_setCpf (Potential< GUM_SCALAR > *cpf)
virtual PRMType *	_type ()
virtual void	_type (PRMType *t)

Built-in type
enum	ClassElementType {   prm_attribute, prm_aggregate, prm_refslot, prm_slotchain,   prm_parameter }
	Returns true if obj_ptr is of type PRMReferenceSlot. More...
static std::string	enum2str (ClassElementType type)
	Returns true if obj_ptr is of type PRMReferenceSlot. More...
static INLINE bool	isReferenceSlot (const PRMClassElement< GUM_SCALAR > &elt)
	Returns true if obj_ptr is of type PRMReferenceSlot. More...
static INLINE bool	isAttribute (const PRMClassElement< GUM_SCALAR > &elt)
	Returns true if obj_ptr is of type PRMAttribute. More...
static INLINE bool	isAggregate (const PRMClassElement< GUM_SCALAR > &elt)
	Return true if obj is of type PRMAggregate. More...
static INLINE bool	isSlotChain (const PRMClassElement< GUM_SCALAR > &elt)
	Return true if obj is of type PRMSlotChain. More...
static INLINE bool	isParameter (const PRMClassElement< GUM_SCALAR > &elt)
	Return true if obj is of type PRMParameter. More...

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

Detailed Description

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

<agrum/PRM/elements/funcAttribute.h>

This class overload gum::prm::PRMClassElement::_addParent() and gum::prm::PRMClassElement::_addChild with empty methods.

This class should be used when dealing with functions such as Noisy-Or which require special method calls to add parents. When dealing with such attributes, you should create the MultiDim yourself and populate it with the attribute's parents.

See gum::prm::PRMFactory::addAttribute(PRMAttribute*) for more details.

Definition at line 55 of file PRMFuncAttribute.h.

Member Enumeration Documentation

ClassElementType

template<typename GUM_SCALAR>

enum gum::prm::PRMClassElement::ClassElementType

inherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Enumerator
prm_attribute
prm_aggregate
prm_refslot
prm_slotchain
prm_parameter

Definition at line 92 of file PRMClassElement.h.

                            {
        prm_attribute,
        prm_aggregate,
        prm_refslot,
        prm_slotchain,
        prm_parameter
      };

prm_type

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

stronginherited

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

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

Enumerator
ALL
CLASS
PRM_INTERFACE
CLASS_ELT
TYPE
SYSTEM
INSTANCE

Definition at line 66 of file PRMObject.h.

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

Constructor & Destructor Documentation

PRMFuncAttribute() [1/2]

template<typename GUM_SCALAR >

INLINE gum::prm::PRMFuncAttribute< GUM_SCALAR >::PRMFuncAttribute	(	const std::string &	name,
		const PRMType &	type,
		MultiDimImplementation< GUM_SCALAR > *	impl = new MultiDimArray< GUM_SCALAR >()
	)

Constructor used by gum::Class.

This will create an PRMFuncAttribute with only one variable: type and with the given implementation.

Parameters

name	The name of this PRMFuncAttribute.
type	The type of this PRMFuncAttribute, it is copied.
impl	The MultiDimImplementation used by the internal Potential of this PRMFuncAttribute. it will be deleted after the call of ~PRMFuncAttribute.

Definition at line 32 of file PRMFuncAttribute_tpl.h.

References gum::prm::PRMType::name().

                                                   :
        PRMScalarAttribute< GUM_SCALAR >(name, type, impl) {
      std::stringstream str;
      str << "In FuncAttribute(" << name << ", " << type.name() << ", " << impl
          << ")";
      GUM_CONSTRUCTOR(PRMFuncAttribute);
    }

Here is the call graph for this function:

~PRMFuncAttribute()

template<typename GUM_SCALAR >

INLINE gum::prm::PRMFuncAttribute< GUM_SCALAR >::~PRMFuncAttribute ( )

virtual

Destructor.

Definition at line 44 of file PRMFuncAttribute_tpl.h.

                                                             {
      GUM_DESTRUCTOR(PRMFuncAttribute);
    }

PRMFuncAttribute() [2/2]

template<typename GUM_SCALAR >

INLINE gum::prm::PRMFuncAttribute< GUM_SCALAR >::PRMFuncAttribute ( const PRMFuncAttribute< GUM_SCALAR > &  source )

protected

Copy constructor. Don't use it.

Definition at line 57 of file PRMFuncAttribute_tpl.h.

References GUM_ERROR, and gum::prm::PRMFuncAttribute< GUM_SCALAR >::operator=().

                                                     :
        PRMScalarAttribute< GUM_SCALAR >(source) {
      GUM_CONS_CPY(PRMFuncAttribute);
      GUM_ERROR(FatalError, "illegal call to copy constructor");
    }

Here is the call graph for this function:

Member Function Documentation

_setCpf()

template<typename GUM_SCALAR >

INLINE void gum::prm::PRMFuncAttribute< GUM_SCALAR >::_setCpf ( Potential< GUM_SCALAR > *  cpf )

protectedvirtual

Definition at line 72 of file PRMFuncAttribute_tpl.h.

References GUM_ERROR.

                                                                           {
      GUM_ERROR(OperationNotAllowed,
                "Cannot change CPF of a functional attribute");
    }

_type() [1/2]

template<typename GUM_SCALAR >

PRMType * gum::prm::PRMScalarAttribute< GUM_SCALAR >::_type ( )

protectedvirtualinherited

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

Definition at line 269 of file PRMScalarAttribute_tpl.h.

References gum::prm::PRMScalarAttribute< GUM_SCALAR >::__type.

                                                     {
      return __type;
    }

_type() [2/2]

template<typename GUM_SCALAR >

void gum::prm::PRMScalarAttribute< GUM_SCALAR >::_type ( PRMType *  t )

protectedvirtualinherited

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

Definition at line 274 of file PRMScalarAttribute_tpl.h.

References gum::prm::PRMScalarAttribute< GUM_SCALAR >::__cpf, gum::prm::PRMScalarAttribute< GUM_SCALAR >::__type, gum::DiscreteVariable::domainSize(), gum::Instantiation::end(), GUM_ERROR, gum::Instantiation::inc(), and gum::Instantiation::setFirst().

                                                           {
      if (__type->variable().domainSize() != t->variable().domainSize()) {
        GUM_ERROR(OperationNotAllowed,
                  "Cannot replace types with difference domain size");
      }
      auto old = __cpf;

      __cpf = new Potential< GUM_SCALAR >();

      for (auto var : old->variablesSequence()) {
        if (var != &(__type->variable())) {
          __cpf->add(*var);
        } else {
          __cpf->add(t->variable());
        }
      }

      Instantiation inst(__cpf), jnst(old);

      for (inst.setFirst(), jnst.setFirst(); !(inst.end() || jnst.end());
           inst.inc(), jnst.inc()) {
        __cpf->set(inst, old->get(jnst));
      }

      delete old;

      __type = t;

      GUM_ASSERT(__cpf->contains(__type->variable()));
      GUM_ASSERT(inst.end() && jnst.end());
    }

Here is the call graph for this function:

addChild()

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement::_addChild().

Reimplemented from gum::prm::PRMScalarAttribute< GUM_SCALAR >.

Definition at line 53 of file PRMFuncAttribute_tpl.h.

                                                 {}

addParent()

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement::_addParent().

Reimplemented from gum::prm::PRMScalarAttribute< GUM_SCALAR >.

Definition at line 49 of file PRMFuncAttribute_tpl.h.

                                                 {}

becomeCastDescendant()

template<typename GUM_SCALAR >

void gum::prm::PRMScalarAttribute< GUM_SCALAR >::becomeCastDescendant ( PRMType &  subtype )

virtualinherited

See gum::PRMClassElement::elt_type().

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

Definition at line 209 of file PRMScalarAttribute_tpl.h.

References gum::prm::PRMScalarAttribute< GUM_SCALAR >::__cpf, gum::Instantiation::end(), gum::Instantiation::inc(), gum::prm::PRMType::label_map(), gum::Instantiation::pos(), gum::Instantiation::setFirst(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::type(), and gum::prm::PRMType::variable().

                                                                                {
      delete __cpf;
      __cpf = new Potential< GUM_SCALAR >();
      __cpf->add(type().variable());
      __cpf->add(subtype.variable());

      Instantiation inst(*__cpf);

      for (inst.setFirst(); !inst.end(); inst.inc()) {
        auto my_pos = inst.pos(subtype.variable());
        if (subtype.label_map()[my_pos] == inst.pos(type().variable())) {
          __cpf->set(inst, 1);
        } else {
          __cpf->set(inst, 0);
        }
      }
    }

Here is the call graph for this function:

cast()

template<typename GUM_SCALAR >

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

virtualinherited

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

Parameters

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

Exceptions

OperationNotAllowed

If the cast is impossible.

Definition at line 73 of file PRMClassElement_tpl.h.

Referenced by gum::prm::PRMFactory< GUM_SCALAR >::addNoisyOrCompound(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::getCastDescendant(), and gum::prm::PRMClassElement< double >::isParameter().

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

Here is the caller graph for this function:

copy()

template<typename GUM_SCALAR >

PRMAttribute< GUM_SCALAR > * gum::prm::PRMScalarAttribute< GUM_SCALAR >::copy ( Bijection< const DiscreteVariable *, const DiscreteVariable * >  bij ) const

virtualinherited

See gum::PRMClassElement::elt_type().

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

Definition at line 78 of file PRMScalarAttribute_tpl.h.

References gum::prm::copyPotential(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::cpf(), gum::BijectionImplementation< T1, T2, Alloc, std::is_scalar< T1 >::value &&std::is_scalar< T2 >::value >::existsFirst(), gum::BijectionImplementation< T1, T2, Alloc, std::is_scalar< T1 >::value &&std::is_scalar< T2 >::value >::insert(), gum::prm::PRMObject::name(), and gum::prm::PRMScalarAttribute< GUM_SCALAR >::type().

                                                                                {
      auto copy = new PRMScalarAttribute< GUM_SCALAR >(this->name(), this->type());

      if (!bij.existsFirst(&(type().variable()))) {
        bij.insert(&(type().variable()), &(copy->type().variable()));
      }

      delete copy->__cpf;
      copy->__cpf = copyPotential(bij, cpf());

      return copy;
    }

Here is the call graph for this function:

copyCpf()

template<typename GUM_SCALAR >

void gum::prm::PRMScalarAttribute< GUM_SCALAR >::copyCpf ( const Bijection< const DiscreteVariable *, const DiscreteVariable * > &  bif, const PRMAttribute< GUM_SCALAR > &  source  )

virtualinherited

See gum::PRMClassElement::elt_type().

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

Definition at line 93 of file PRMScalarAttribute_tpl.h.

References gum::prm::PRMScalarAttribute< GUM_SCALAR >::__cpf, gum::prm::PRMScalarAttribute< GUM_SCALAR >::__type, gum::prm::PRMAttribute< GUM_SCALAR >::cpf(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::operator=(), gum::BijectionImplementation< T1, T2, Alloc, std::is_scalar< T1 >::value &&std::is_scalar< T2 >::value >::second(), and gum::prm::PRMAttribute< GUM_SCALAR >::type().

                                                 {
      delete __cpf;
      __cpf = new Potential< GUM_SCALAR >();

      for (auto var : source.cpf().variablesSequence()) {
        __cpf->add(*(bij.second(var)));
      }

      Instantiation inst(*__cpf), jnst(source.cpf());

      for (inst.setFirst(), jnst.setFirst(); !(inst.end() || jnst.end());
           inst.inc(), jnst.inc()) {
        __cpf->set(inst, source.cpf().get(jnst));
      }

      GUM_ASSERT(inst.end() && jnst.end());
      GUM_ASSERT(__cpf->contains(__type->variable()));
      GUM_ASSERT(!__cpf->contains(source.type().variable()));
    }

Here is the call graph for this function:

cpf()

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::prm::PRMScalarAttribute< GUM_SCALAR >::cpf ( ) const

virtualinherited

See gum::PRMClassElement::cpf().

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

Definition at line 140 of file PRMScalarAttribute_tpl.h.

References gum::prm::PRMScalarAttribute< GUM_SCALAR >::__cpf.

Referenced by gum::prm::PRMScalarAttribute< GUM_SCALAR >::copy(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMAggregate< double >::getCastDescendant(), and gum::prm::PRMScalarAttribute< GUM_SCALAR >::newFactory().

                                                             {
      return *__cpf;
    }

Here is the caller graph for this function:

elt_type()

template<typename GUM_SCALAR >

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

virtualinherited

See gum::PRMClassElement::elt_type().

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

Definition at line 124 of file PRMScalarAttribute_tpl.h.

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

                                                        {
      return this->prm_attribute;
    }

enum2str() [1/2]

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

inlinestaticinherited

Returns the string representation of a PRMObject.

Definition at line 80 of file PRMObject.h.

References gum::prm::PRMObject::CLASS, gum::prm::PRMObject::CLASS_ELT, gum::prm::PRMObject::INSTANCE, gum::prm::PRMObject::PRM_INTERFACE, gum::prm::PRMObject::SYSTEM, and gum::prm::PRMObject::TYPE.

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

                                               {
        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";
        }
      }

Here is the caller graph for this function:

enum2str() [2/2]

template<typename GUM_SCALAR>

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

inlinestaticinherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 100 of file PRMClassElement.h.

                                                       {
        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";
        }
      }

getCastDescendant()

template<typename GUM_SCALAR >

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

virtualinherited

See gum::PRMClassElement::elt_type().

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

Definition at line 165 of file PRMScalarAttribute_tpl.h.

References gum::prm::PRMScalarAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMClassElement< GUM_SCALAR >::cast(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::cpf(), GUM_ERROR, gum::prm::PRMType::label_map(), gum::prm::PRMObject::name(), gum::prm::PRMType::superType(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::type(), and gum::prm::PRMType::variable().

                                                                 {
      PRMScalarAttribute< GUM_SCALAR >* cast = 0;

      try {
        cast =
           new PRMScalarAttribute< GUM_SCALAR >(this->name(), type().superType());
      } catch (NotFound&) {
        GUM_ERROR(OperationNotAllowed,
                  "this ScalarAttribute can not have cast descendant");
      }

      cast->addParent(*this);
      const DiscreteVariable& my_var = type().variable();
      DiscreteVariable&       cast_var = cast->type().variable();
      Instantiation           inst(cast->cpf());

      for (inst.setFirst(); !inst.end(); inst.inc()) {
        if (type().label_map()[inst.val(my_var)] == inst.val(cast_var)) {
          cast->cpf().set(inst, 1);
        } else {
          cast->cpf().set(inst, 0);
        }
      }

      return cast;
    }

Here is the call graph for this function:

id()

template<typename GUM_SCALAR >

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

inherited

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

Definition at line 52 of file PRMClassElement_tpl.h.

Referenced by gum::prm::PRMClass< double >::__addCastDescendants(), gum::prm::PRMInterface< double >::__addCastDescendants(), gum::prm::PRMClass< double >::__checkInterface(), gum::prm::PRMClass< double >::__checkRefInterface(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAggregates(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAttribute(), gum::prm::PRMSlotChain< double >::__copyLastElt(), gum::prm::SVE< GUM_SCALAR >::__getAggPotential(), gum::prm::PRMSystem< double >::__groundPotential(), gum::prm::PRMClass< double >::__inheritClass(), gum::prm::InstanceBayesNet< GUM_SCALAR >::__init(), gum::prm::ClassBayesNet< GUM_SCALAR >::__init(), gum::prm::PRMInstance< GUM_SCALAR >::__instantiateSlotChain(), gum::prm::PRMInterface< double >::__overloadAttribute(), gum::prm::PRMClass< double >::__overloadAttribute(), gum::prm::PRMClass< double >::__overloadParameter(), gum::prm::PRMClass< double >::__overloadReference(), gum::prm::PRMInterface< double >::__overloadReferenceSlot(), gum::prm::SVED< GUM_SCALAR >::_marginal(), gum::prm::SVE< GUM_SCALAR >::_marginal(), gum::prm::PRMInterface< double >::add(), gum::prm::PRMClass< double >::add(), gum::prm::PRMClass< double >::addArc(), gum::prm::PRMClass< double >::inheritAggregates(), gum::prm::PRMClassElement< double >::isParameter(), gum::prm::PRMClass< double >::overload(), gum::prm::PRMInterface< double >::overload(), and gum::prm::PRMFactory< GUM_SCALAR >::startAttribute().

                                                          {
      return __id;
    }

Here is the caller graph for this function:

isAggregate()

template<typename GUM_SCALAR>

static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isAggregate ( const PRMClassElement< GUM_SCALAR > &  elt )

inlinestaticinherited

Return true if obj is of type PRMAggregate.

Definition at line 128 of file PRMClassElement.h.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::CData::CData().

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

Here is the caller graph for this function:

isAttribute()

template<typename GUM_SCALAR>

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

inlinestaticinherited

Returns true if obj_ptr is of type PRMAttribute.

Definition at line 123 of file PRMClassElement.h.

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

isClass()

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

inlinestaticinherited

Returns true if obj_ptr is of type Class.

Definition at line 99 of file PRMObject.h.

References gum::prm::PRMObject::CLASS, and gum::prm::PRMObject::obj_type().

Referenced by gum::prm::PRMFactory< GUM_SCALAR >::startAttribute().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isInstance()

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

inlinestaticinherited

Returns true if obj_ptr is of type PRMInstance.

Definition at line 109 of file PRMObject.h.

References gum::prm::PRMObject::INSTANCE, gum::prm::PRMObject::name(), gum::prm::PRMObject::obj_type(), gum::prm::PRMObject::operator!=(), gum::prm::PRMObject::operator=(), gum::prm::PRMObject::operator==(), gum::prm::PRMObject::PRMObject(), and gum::prm::PRMObject::~PRMObject().

                                                          {
        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 104 of file PRMObject.h.

References gum::prm::PRMObject::obj_type(), and gum::prm::PRMObject::PRM_INTERFACE.

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

Here is the call graph for this function:

isParameter()

template<typename GUM_SCALAR>

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

inlinestaticinherited

Return true if obj is of type PRMParameter.

Definition at line 138 of file PRMClassElement.h.

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

isReferenceSlot()

template<typename GUM_SCALAR>

static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isReferenceSlot ( const PRMClassElement< GUM_SCALAR > &  elt )

inlinestaticinherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 118 of file PRMClassElement.h.

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

isSlotChain()

template<typename GUM_SCALAR>

static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isSlotChain ( const PRMClassElement< GUM_SCALAR > &  elt )

inlinestaticinherited

Return true if obj is of type PRMSlotChain.

Definition at line 133 of file PRMClassElement.h.

Referenced by gum::prm::PRMFactory< GUM_SCALAR >::__retrieveInputs().

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

Here is the caller graph for this function:

LEFT_CAST()

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

inlinestaticinherited

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

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

Definition at line 76 of file PRMObject.h.

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

{ return "("; }

Here is the caller graph for this function:

name() [1/2]

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

inherited

Returns the name of this object.

Definition at line 32 of file PRMObject_inl.h.

References gum::prm::PRMObject::__name.

Referenced by gum::prm::SVE< GUM_SCALAR >::__addDelayedVariable(), gum::prm::PRMClass< double >::__addIOInterfaceFlags(), gum::prm::PRMFactory< GUM_SCALAR >::__addParent(), gum::prm::PRMInstance< GUM_SCALAR >::__addReferingInstance(), gum::prm::PRMClass< double >::__checkInterface(), gum::prm::PRMFactory< GUM_SCALAR >::__checkInterfaceImplementation(), gum::prm::PRMClass< double >::__checkInterfaces(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::__checkRawCPT(), gum::prm::PRMClass< double >::__checkRefInterface(), gum::prm::PRMClass< double >::__checkRefInterfaces(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::__checkRuleCPTSumsTo1(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAggregates(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAttribute(), gum::prm::PRMSlotChain< double >::__copyLastElt(), gum::prm::PRMSystem< double >::__groundAttr(), gum::prm::PRMSystem< double >::__groundPotential(), gum::prm::PRMSystem< double >::__groundRef(), gum::prm::PRMClass< double >::__inheritClass(), gum::prm::PRMInterface< double >::__overloadAttribute(), gum::prm::PRMClass< double >::__overloadAttribute(), gum::prm::PRMClass< double >::__overloadParameter(), gum::prm::PRMClass< double >::__overloadReference(), gum::prm::PRMInterface< double >::__overloadReferenceSlot(), gum::prm::__print_attribute__(), gum::prm::__print_instance__(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::__str(), gum::prm::StructuredInference< GUM_SCALAR >::__str(), gum::prm::PRMInterface< double >::add(), gum::prm::PRMSystem< double >::add(), gum::prm::PRMClass< double >::add(), gum::prm::PRMFactory< GUM_SCALAR >::addAggregator(), gum::prm::PRMFormAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMFormAttribute< GUM_SCALAR >::copy(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::copy(), gum::prm::o3prmr::O3prmrInterpreter::findAttributeName(), gum::prm::o3prmr::O3prmrInterpreter::findInstanceName(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMClass< double >::inheritAggregates(), gum::prm::PRMClass< double >::isCastDescendant(), gum::prm::PRMObject::isInstance(), gum::prm::PRMObject::name(), gum::prm::PRMType::name(), gum::prm::PRMFormAttribute< GUM_SCALAR >::newFactory(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::newFactory(), gum::prm::PRMType::operator!=(), gum::prm::PRMObject::operator!=(), operator<<(), gum::prm::PRMType::operator==(), gum::prm::PRMObject::operator==(), gum::prm::PRMClass< double >::overload(), gum::prm::PRMInterface< double >::overload(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMReferenceSlot< double >::PRMReferenceSlot(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), gum::prm::PRMFactory< GUM_SCALAR >::startClass(), gum::prm::PRMFactory< GUM_SCALAR >::startInterface(), gum::prm::PRMFactory< GUM_SCALAR >::startSystem(), and gum::prm::PRMAggregate< double >::str2enum().

{ return __name; }

name() [2/2]

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

inherited

Change the name of the PRM Object.

Warning

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

Definition at line 36 of file PRMObject_inl.h.

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

{ __name = name; }

Here is the call graph for this function:

newFactory()

template<typename GUM_SCALAR >

PRMAttribute< GUM_SCALAR > * gum::prm::PRMScalarAttribute< GUM_SCALAR >::newFactory ( const PRMClass< GUM_SCALAR > &  c ) const

virtualinherited

See gum::PRMClassElement::elt_type().

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

Definition at line 69 of file PRMScalarAttribute_tpl.h.

References gum::prm::PRMScalarAttribute< GUM_SCALAR >::cpf(), gum::prm::PRMObject::name(), and gum::prm::PRMScalarAttribute< GUM_SCALAR >::type().

                                              {
      auto impl = static_cast< MultiDimImplementation< GUM_SCALAR >* >(
         this->cpf().content()->newFactory());
      return new PRMScalarAttribute< GUM_SCALAR >(
         this->name(), this->type(), impl);
    }

Here is the call graph for this function:

obj_type()

template<typename GUM_SCALAR >

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

virtualinherited

See also

gum::PRMObject::obj_type().

Implements gum::prm::PRMObject.

Definition at line 57 of file PRMClassElement_tpl.h.

Referenced by gum::prm::PRMClassElement< double >::isParameter().

                                                                           {
      return prm_type::CLASS_ELT;
    }

Here is the caller graph for this function:

operator!=()

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

inherited

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

Definition at line 46 of file PRMObject_inl.h.

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

Referenced by gum::prm::PRMObject::isInstance().

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

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

template<typename GUM_SCALAR >

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

protected

Copy operator. Don't use it.

Definition at line 66 of file PRMFuncAttribute_tpl.h.

References GUM_ERROR.

Referenced by gum::prm::PRMFuncAttribute< GUM_SCALAR >::PRMFuncAttribute().

                                                                                                 {
      GUM_ERROR(FatalError, "illegal call to copy operator");
    }

Here is the caller graph for this function:

operator==()

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

inherited

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

Definition at line 40 of file PRMObject_inl.h.

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

Referenced by gum::prm::PRMObject::isInstance().

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

Here is the call graph for this function:

Here is the caller graph for this function:

overload()

template<typename GUM_SCALAR>

void gum::prm::PRMAttribute< GUM_SCALAR >::overload ( PRMAttribute< GUM_SCALAR > *  source )

virtualinherited

Set this as overload of source (necessayr to preserver internal pointers for MultiDims).

Definition at line 50 of file PRMAttribute_tpl.h.

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

                                                                                {
      auto old_type = this->_type();
      this->_type(source->_type());
      source->_type(old_type);
    }

Here is the caller graph for this function:

RIGHT_CAST()

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

inlinestaticinherited

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

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

Definition at line 77 of file PRMObject.h.

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

{ return ")"; }

Here is the caller graph for this function:

safeName()

template<typename GUM_SCALAR >

INLINE const std::string & gum::prm::PRMClassElement< GUM_SCALAR >::safeName ( ) const

inherited

Returns the safe name of this PRMClassElement, if any.

This will only work if this PRMClassElement is an PRMAttribute or an PRMAggregate.

Returns

Returns the safe name of this PRMClassElement.

Exceptions

NotFound&

Raised if this PRMClassElement does not have any safe name.

Definition at line 67 of file PRMClassElement_tpl.h.

Referenced by gum::prm::PRMClass< double >::__addCastDescendants(), gum::prm::PRMInterface< double >::__addCastDescendants(), gum::prm::PRMFactory< GUM_SCALAR >::__addParent(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAttributeCPF(), gum::prm::SVED< GUM_SCALAR >::__getAggPotential(), gum::prm::PRMSystem< double >::__groundPotential(), gum::prm::PRMSystem< double >::__groundRef(), gum::prm::PRMClass< double >::__inheritClass(), gum::prm::PRMClass< double >::__overloadAggregate(), gum::prm::PRMInterface< double >::__overloadAttribute(), gum::prm::PRMClass< double >::__overloadAttribute(), gum::prm::PRMClass< double >::__overloadParameter(), gum::prm::PRMClass< double >::__overloadReference(), gum::prm::PRMInterface< double >::__overloadReferenceSlot(), gum::prm::__print_attribute__(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::__str(), gum::prm::StructuredInference< GUM_SCALAR >::__str(), gum::prm::PRMClassElementContainer< double >::_getIOFlag(), gum::prm::PRMClassElementContainer< double >::_setIOFlag(), gum::prm::PRMInterface< double >::add(), gum::prm::PRMClass< double >::add(), gum::prm::PRMFactory< GUM_SCALAR >::addAggregator(), gum::prm::PRMFactory< GUM_SCALAR >::addAttribute(), gum::prm::PRMClassElementContainer< double >::belongsTo(), gum::prm::PRMClass< double >::inheritAggregates(), gum::prm::PRMClassElement< double >::isParameter(), gum::prm::PRMClassElementContainer< double >::setInputNode(), and gum::prm::PRMClassElementContainer< double >::setOutputNode().

                                                                          {
      return _safeName;
    }

Here is the caller graph for this function:

setAsCastDescendant()

template<typename GUM_SCALAR >

void gum::prm::PRMScalarAttribute< GUM_SCALAR >::setAsCastDescendant ( PRMAttribute< GUM_SCALAR > *  attr )

virtualinherited

See gum::PRMClassElement::elt_type().

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

Definition at line 193 of file PRMScalarAttribute_tpl.h.

References gum::prm::PRMAttribute< GUM_SCALAR >::becomeCastDescendant(), GUM_ERROR, gum::prm::PRMType::name(), gum::prm::PRMType::setSuper(), gum::prm::PRMAttribute< GUM_SCALAR >::type(), and gum::prm::PRMScalarAttribute< GUM_SCALAR >::type().

                                         {
      try {
        type().setSuper(cast->type());
      } catch (OperationNotAllowed&) {
        GUM_ERROR(OperationNotAllowed,
                  "this ScalarAttribute can not have cast descendant");
      } catch (WrongType&) {
        std::stringstream msg;
        msg << type().name() << " is not a subtype of " << cast->type().name();
        GUM_ERROR(WrongType, msg.str());
      }
      cast->becomeCastDescendant(type());
    }

Here is the call graph for this function:

setId()

template<typename GUM_SCALAR >

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

virtualinherited

Used to assign the id of this element.

Definition at line 62 of file PRMClassElement_tpl.h.

Referenced by gum::prm::PRMClass< double >::__addCastDescendants(), gum::prm::PRMInterface< double >::__addCastDescendants(), gum::prm::PRMClass< double >::__checkInterface(), gum::prm::PRMClass< double >::__checkRefInterface(), gum::prm::PRMSlotChain< double >::__copyLastElt(), gum::prm::PRMClass< double >::__inheritClass(), gum::prm::PRMInterface< double >::__inheritInterface(), gum::prm::PRMInterface< double >::__overloadAttribute(), gum::prm::PRMClass< double >::__overloadAttribute(), gum::prm::PRMClass< double >::__overloadParameter(), gum::prm::PRMClass< double >::__overloadReference(), gum::prm::PRMInterface< double >::__overloadReferenceSlot(), gum::prm::PRMInterface< double >::add(), gum::prm::PRMClass< double >::add(), gum::prm::PRMClass< double >::inheritAggregates(), gum::prm::PRMClass< double >::inheritParameters(), gum::prm::PRMClass< double >::inheritReferenceSlots(), gum::prm::PRMClass< double >::inheritSlotChains(), and gum::prm::PRMClassElement< double >::isParameter().

                                                              {
      __id = id;
    }

Here is the caller graph for this function:

swap()

template<typename GUM_SCALAR >

void gum::prm::PRMScalarAttribute< GUM_SCALAR >::swap ( const PRMType &  old_type, const PRMType &  new_type  )

virtualinherited

Swap old_type with new_type in the PRMClassElement cpt.

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

Definition at line 228 of file PRMScalarAttribute_tpl.h.

References gum::prm::PRMScalarAttribute< GUM_SCALAR >::__cpf, gum::prm::PRMScalarAttribute< GUM_SCALAR >::__type, gum::DiscreteVariable::domainSize(), gum::Instantiation::end(), GUM_ERROR, gum::Instantiation::inc(), gum::prm::PRMType::name(), gum::Instantiation::setFirst(), and gum::prm::PRMType::variable().

                                                                         {
      if (&(old_type) == __type) {
        GUM_ERROR(OperationNotAllowed, "Cannot replace attribute own type");
      }
      if (old_type->domainSize() != new_type->domainSize()) {
        GUM_ERROR(OperationNotAllowed,
                  "Cannot replace types with difference domain size");
      }
      if (!__cpf->contains(old_type.variable())) {
        GUM_ERROR(NotFound, "could not find variable " + old_type.name());
      }

      auto old = __cpf;

      __cpf = new Potential< GUM_SCALAR >();

      for (auto var : old->variablesSequence()) {
        if (var != &(old_type.variable())) {
          __cpf->add(*var);
        } else {
          __cpf->add(new_type.variable());
        }
      }

      Instantiation inst(__cpf), jnst(old);

      for (inst.setFirst(), jnst.setFirst(); !(inst.end() || jnst.end());
           inst.inc(), jnst.inc()) {
        __cpf->set(inst, old->get(jnst));
      }

      delete old;

      GUM_ASSERT(inst.end() && jnst.end());
      GUM_ASSERT(__cpf->contains(__type->variable()));
      GUM_ASSERT(__cpf->contains(new_type.variable()));
      GUM_ASSERT(!__cpf->contains(old_type.variable()));
    }

Here is the call graph for this function:

type() [1/2]

template<typename GUM_SCALAR >

INLINE PRMType & gum::prm::PRMScalarAttribute< GUM_SCALAR >::type ( )

virtualinherited

See gum::PRMClassElement::type().

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

Definition at line 129 of file PRMScalarAttribute_tpl.h.

References gum::prm::PRMScalarAttribute< GUM_SCALAR >::__type.

Referenced by gum::prm::PRMScalarAttribute< GUM_SCALAR >::becomeCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::copy(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMAggregate< double >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::newFactory(), and gum::prm::PRMScalarAttribute< GUM_SCALAR >::setAsCastDescendant().

                                                           {
      return *__type;
    }

Here is the caller graph for this function:

type() [2/2]

template<typename GUM_SCALAR >

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

virtualinherited

See gum::PRMClassElement::type().

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

Definition at line 134 of file PRMScalarAttribute_tpl.h.

References gum::prm::PRMScalarAttribute< GUM_SCALAR >::__type.

                                                                       {
      return *__type;
    }

Member Data Documentation

_safeName

template<typename GUM_SCALAR>

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

protectedinherited

The safe name of this PRMClassElement.

Definition at line 257 of file PRMClassElement.h.

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

---

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

• agrum/PRM/elements/PRMFuncAttribute.h
• agrum/PRM/elements/PRMFuncAttribute_tpl.h