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

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

#include <PRMScalarAttribute.h>

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

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

Public Member Functions
Constructor & destructor.
	PRMScalarAttribute (const std::string &name, const PRMType &type, MultiDimImplementation< GUM_SCALAR > *impl=new MultiDimArray< GUM_SCALAR >())
	Constructor used by gum::Class. More...
virtual	~PRMScalarAttribute ()
	Destructor. 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 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...
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
	PRMScalarAttribute (const PRMScalarAttribute &source)
	Copy constructor. Don't use it. More...
PRMScalarAttribute &	operator= (const PRMScalarAttribute &from)
	Copy operator. Don't use it. More...
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::PRMScalarAttribute< GUM_SCALAR >

<agrum/PRM/elements/scalarAttribute.h>

PRMScalarAttribute is a member of a Class in a PRM.

A PRMScalarAttribute is defined by its name, its containing class, its type and by a Conditional Probability Function (aka CPF but represented by a Potential).

An attribute in a PRM is the equivalent of a random variable in a bayesian network.

This class is constructed by a gum::PRMFactory and is deleted by its gum::Class.

Built-in copies (copy constructor and copy operator) are illegal due to various problems raised by redondant information.

See also

PRM PRMFactory Class PRMClassElement PRMType Potential

Definition at line 66 of file PRMScalarAttribute.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 94 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 68 of file PRMObject.h.

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

Constructor & Destructor Documentation

PRMScalarAttribute() [1/2]

template<typename GUM_SCALAR >

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

Constructor used by gum::Class.

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

Parameters

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

Definition at line 40 of file PRMScalarAttribute_tpl.h.

                                                   :
        PRMAttribute< GUM_SCALAR >(name),
        type__(new PRMType(type)), cpf__(new Potential< GUM_SCALAR >(impl)) {
      GUM_CONSTRUCTOR(PRMScalarAttribute);
      cpf__->add(type__->variable());

      this->safeName_ = PRMObject::LEFT_CAST() + type__->name()
                      + PRMObject::RIGHT_CAST() + name;
    }

~PRMScalarAttribute()

template<typename GUM_SCALAR >

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

virtual

Destructor.

Definition at line 64 of file PRMScalarAttribute_tpl.h.

                                                          {
      GUM_DESTRUCTOR(PRMScalarAttribute);
      delete cpf__;
      delete type__;
    }

PRMScalarAttribute() [2/2]

template<typename GUM_SCALAR >

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

protected

Copy constructor. Don't use it.

Definition at line 54 of file PRMScalarAttribute_tpl.h.

                                                       :
        PRMAttribute< GUM_SCALAR >(source),
        type__(0), cpf__(0) {
      GUM_CONS_CPY(PRMScalarAttribute);
      GUM_ERROR(FatalError,
                "Illegal call to the copy constructor of gum::ScalarAttribute");
    }

Member Function Documentation

addChild()

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement::addChild_().

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

Reimplemented in gum::prm::PRMFuncAttribute< GUM_SCALAR >.

Definition at line 163 of file PRMScalarAttribute_tpl.h.

                                                 {}

addParent()

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement::addParent_().

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

Reimplemented in gum::prm::PRMFuncAttribute< GUM_SCALAR >.

Definition at line 148 of file PRMScalarAttribute_tpl.h.

                                                 {
      try {
        cpf__->add(elt.type().variable());
      } catch (DuplicateElement&) {
        GUM_ERROR(DuplicateElement,
                  elt.name() << " as parent of " << this->name());
      } catch (OperationNotAllowed&) {
        GUM_ERROR(OperationNotAllowed,
                  elt.name() << " of wrong type as parent of " << this->name());
      }
    }

becomeCastDescendant()

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement::elt_type().

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

Definition at line 212 of file PRMScalarAttribute_tpl.h.

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

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 75 of file PRMClassElement_tpl.h.

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

copy()

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement::elt_type().

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

Definition at line 81 of file PRMScalarAttribute_tpl.h.

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

copyCpf()

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement::elt_type().

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

Definition at line 96 of file PRMScalarAttribute_tpl.h.

                                                 {
      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()));
    }

cpf()

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement::cpf().

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

Definition at line 143 of file PRMScalarAttribute_tpl.h.

                                                             {
      return *cpf__;
    }

elt_type()

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement::elt_type().

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

Definition at line 127 of file PRMScalarAttribute_tpl.h.

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

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

virtual

See gum::PRMClassElement::elt_type().

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

Definition at line 168 of file PRMScalarAttribute_tpl.h.

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

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 54 of file PRMClassElement_tpl.h.

                                                          {
      return id__;
    }

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 137 of file PRMClassElement.h.

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

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 132 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 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:

isInstance()

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

inlinestaticinherited

Returns true if obj_ptr is of type PRMInstance.

Definition at line 119 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 114 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:

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 147 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 127 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 142 of file PRMClassElement.h.

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

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:

newFactory()

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement::elt_type().

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

Definition at line 71 of file PRMScalarAttribute_tpl.h.

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

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 59 of file PRMClassElement_tpl.h.

                                                                           {
      return prm_type::CLASS_ELT;
    }

operator!=()

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

inherited

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

Definition at line 48 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=()

template<typename GUM_SCALAR >

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

protected

Copy operator. Don't use it.

Definition at line 119 of file PRMScalarAttribute_tpl.h.

                                                     {
      GUM_ERROR(FatalError,
                "Illegal call to the copy operator of gum::ScalarAttribute");
    }

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:

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 52 of file PRMAttribute_tpl.h.

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

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

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

                                                                          {
      return safeName_;
    }

setAsCastDescendant()

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement::elt_type().

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

Definition at line 196 of file PRMScalarAttribute_tpl.h.

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

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 64 of file PRMClassElement_tpl.h.

                                                              {
      id__ = id;
    }

swap()

template<typename GUM_SCALAR >

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

virtual

Swap old_type with new_type in the PRMClassElement cpt.

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

Definition at line 231 of file PRMScalarAttribute_tpl.h.

                                                                         {
      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()));
    }

type() [1/2]

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement::type().

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

Definition at line 132 of file PRMScalarAttribute_tpl.h.

                                                           {
      return *type__;
    }

type() [2/2]

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement::type().

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

Definition at line 137 of file PRMScalarAttribute_tpl.h.

                                                                       {
      return *type__;
    }

type_() [1/2]

template<typename GUM_SCALAR >

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

protectedvirtual

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

Definition at line 272 of file PRMScalarAttribute_tpl.h.

                                                     {
      return type__;
    }

type_() [2/2]

template<typename GUM_SCALAR >

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

protectedvirtual

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

Definition at line 277 of file PRMScalarAttribute_tpl.h.

                                                           {
      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());
    }

Member Data Documentation

cpf__

template<typename GUM_SCALAR >

Potential< GUM_SCALAR >* gum::prm::PRMScalarAttribute< GUM_SCALAR >::cpf__

private

A pointer on the Potential of this attribute.

Definition at line 155 of file PRMScalarAttribute.h.

safeName_

template<typename GUM_SCALAR>

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

protectedinherited

The safe name of this PRMClassElement.

Definition at line 266 of file PRMClassElement.h.

type__

template<typename GUM_SCALAR >

PRMType* gum::prm::PRMScalarAttribute< GUM_SCALAR >::type__

private

The random variable type of this attribute.

Definition at line 152 of file PRMScalarAttribute.h.

---

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

• agrum/PRM/elements/PRMScalarAttribute.h
• agrum/PRM/elements/PRMScalarAttribute_tpl.h