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

An PRMInstance is a Bayesian Network fragment defined by a Class and used in a PRMSystem. More...

#include <PRMInstance.h>

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

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

Public Member Functions
Constructors & private operators.
	PRMInstance (const std::string &name, PRMClass< GUM_SCALAR > &type)
	Default constructor of an PRMInstance<GUM_SCALAR>. More...
virtual	~PRMInstance ()
	Destructor. More...
Getters & setters.
virtual prm_type	obj_type () const
	Returns the PRM type of this object. More...
PRMClass< GUM_SCALAR > &	type ()
	Returns the type of this instance. More...
const PRMClass< GUM_SCALAR > &	type () const
	Returns the type of this instance. More...
bool	exists (NodeId id) const
	Returns true if id matches an PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
bool	exists (const std::string &name) const
	Returns true if name matches an PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
PRMAttribute< GUM_SCALAR > &	get (NodeId id)
	Getter on an PRMAttribute<GUM_SCALAR> of this PRMInstance<GUM_SCALAR>. More...
PRMAttribute< GUM_SCALAR > &	get (const std::string &name)
	Given a name returns the related PRMAttribute<GUM_SCALAR>. More...
const PRMAttribute< GUM_SCALAR > &	get (NodeId id) const
	Getter on an PRMAttribute<GUM_SCALAR> of this PRMInstance<GUM_SCALAR>. More...
const PRMAttribute< GUM_SCALAR > &	get (const std::string &name) const
	Given a name returns the related PRMClassElement. More...
Size	size () const
	Returns the number of attributes in this PRMInstance<GUM_SCALAR>. More...
Instantiation methods.
void	instantiate ()
	Instantiate all nodes which requires it. More...
const Bijection< const DiscreteVariable *, const DiscreteVariable *> &	bijection () const
	Returns a mapping between DiscreteVariable used in this and the ones used in this PRMInstance<GUM_SCALAR>'s Class<GUM_SCALAR>. More...
Reference handling.
void	add (NodeId id, PRMInstance< GUM_SCALAR > &instance)
	Add an PRMInstance<GUM_SCALAR> to a given PRMReferenceSlot, PRMSlotChain<GUM_SCALAR> or output node. More...
const PRMInstance< GUM_SCALAR > &	getInstance (NodeId id) const
	Fast access to the first instance in a PRMReferenceSlot or PRMSlotChain<GUM_SCALAR>. More...
const Set< PRMInstance< GUM_SCALAR > *> &	getInstances (NodeId id) const
	Returns the Set of PRMInstance<GUM_SCALAR> referenced by id. More...
bool	hasRefAttr (NodeId id) const
	Returns true if id has at least one referring PRMAttribute<GUM_SCALAR>. More...
std::vector< std::pair< PRMInstance< GUM_SCALAR > *, std::string > > &	getRefAttr (NodeId id)
	Returns a vector of pairs of refering attributes of id. More...
const std::vector< std::pair< PRMInstance< GUM_SCALAR > *, std::string > > &	getRefAttr (NodeId id) const
	Returns a vector of pairs of refering attributes of id. 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...

Classes
class	RefConstIterator
	Nested class to iterate over PRMReferenceSlot and PRMSlotChain<GUM_SCALAR> instantiations. More...
class	RefIterator
	Nested class to iterate over PRMReferenceSlot and PRMSlotChain<GUM_SCALAR> instantiations. More...

Iterators
typedef NodeProperty< PRMAttribute< GUM_SCALAR > *>::iterator	iterator
	Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
typedef NodeProperty< PRMAttribute< GUM_SCALAR > *>::const_iterator	const_iterator
	Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
typedef NodeProperty< std::vector< std::pair< PRMInstance< GUM_SCALAR > *, std::string > > *>::iterator	InvRefIterator
	Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
typedef NodeProperty< std::vector< std::pair< PRMInstance< GUM_SCALAR > *, std::string > > *>::const_iterator	InvRefConstIterator
	Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
iterator	begin ()
	Returns an iterator at the begining of the list of gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
const iterator &	end ()
	Returns a reference over the iterator at the end of the list of gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
const_iterator	begin () const
	Returns an iterator at the beginning of the list of gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
const const_iterator &	end () const
	Returns a reference over the iterator at the end of the list of gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
RefIterator	begin (NodeId id)
	Returns an iterator at the beginning of the set of PRMInstance<GUM_SCALAR> associated to a given gum::prm::PRMReferenceSlot or gum::prm::PRMSlotChain<GUM_SCALAR>. More...
RefConstIterator	begin (NodeId id) const
	Returns an iterator at the beginning of the set of PRMInstance<GUM_SCALAR> associated to a given gum::prm::PRMReferenceSlot or gum::prm::PRMSlotChain<GUM_SCALAR>. More...
InvRefIterator	beginInvRef ()
	Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
const InvRefIterator &	endInvRef ()
	Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
InvRefConstIterator	beginInvRef () const
	Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
const InvRefConstIterator &	endInvRef () const
	Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...

Private members.
typedef std::pair< PRMInstance< GUM_SCALAR > *, std::string >	pair
	Code alias. More...
bool	__instantiated
	True if this instance has been instantiated. More...
PRMClass< GUM_SCALAR > *	__type
	The type of this PRMInstance<GUM_SCALAR>. More...
NodeProperty< PRMAttribute< GUM_SCALAR > *>	__nodeIdMap
	The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM_SCALAR>. More...
NodeProperty< Set< PRMInstance< GUM_SCALAR > *> *>	__referenceMap
	Mapping between the gum::prm::PRMReferenceSlot and gum::prm::PRMSlotChain<GUM_SCALAR> in __type / and the PRMInstance<GUM_SCALAR> associated with it. More...
NodeProperty< std::vector< pair > *>	__referingAttr
	The set of pair (instance, attribute) referring an attribute of this instance. More...
Bijection< const DiscreteVariable *, const DiscreteVariable *>	__bijection
	A bijection used for MultiDim handling. 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::PRMInstance< GUM_SCALAR >

An PRMInstance is a Bayesian Network fragment defined by a Class and used in a PRMSystem.

Before using an PRMInstance for inference YOU MUST call PRMInstance::instantiateSlotChains() and PRMInstance::instantiate() on it before, otherwise DiscreteVariable pointers will be inconsistent and inference will be erroneous. Of course, this must be done once you have set all reference in the current system.

See also

PRMClass PRM PRMClassElement

Definition at line 63 of file PRMInstance.h.

Member Typedef Documentation

const_iterator

template<typename GUM_SCALAR>

typedef NodeProperty< PRMAttribute< GUM_SCALAR >* >::const_iterator gum::prm::PRMInstance< GUM_SCALAR >::const_iterator

Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 329 of file PRMInstance.h.

InvRefConstIterator

template<typename GUM_SCALAR>

typedef NodeProperty< std::vector< std::pair< PRMInstance< GUM_SCALAR >*, std::string > >* >::const_iterator gum::prm::PRMInstance< GUM_SCALAR >::InvRefConstIterator

Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 447 of file PRMInstance.h.

InvRefIterator

template<typename GUM_SCALAR>

typedef NodeProperty< std::vector< std::pair< PRMInstance< GUM_SCALAR >*, std::string > >* >::iterator gum::prm::PRMInstance< GUM_SCALAR >::InvRefIterator

Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 444 of file PRMInstance.h.

iterator

template<typename GUM_SCALAR>

typedef NodeProperty< PRMAttribute< GUM_SCALAR >* >::iterator gum::prm::PRMInstance< GUM_SCALAR >::iterator

Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 315 of file PRMInstance.h.

pair

template<typename GUM_SCALAR>

typedef std::pair< PRMInstance< GUM_SCALAR >*, std::string > gum::prm::PRMInstance< GUM_SCALAR >::pair

private

Code alias.

Definition at line 522 of file PRMInstance.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 69 of file PRMObject.h.

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

Constructor & Destructor Documentation

PRMInstance() [1/2]

template<typename GUM_SCALAR >

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

Default constructor of an PRMInstance<GUM_SCALAR>.

When you create an PRMInstance<GUM_SCALAR> all gum::prm::PRMAttribute<GUM_SCALAR> in it's type are added, except for gum::prm::PRMAggregate<GUM_SCALAR> and parameters which are instantiated.

However neither of their children or parents are updated (i.e. DiscreteVariable pointers are inconsistent).

Definition at line 37 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__copyAggregates(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAttribute(), and gum::prm::PRMInstance< GUM_SCALAR >::__type.

                                                                         :
        PRMObject(name),
        __instantiated(false), __type(&type) {
      GUM_CONSTRUCTOR(PRMInstance);

      // First we create attributes for each aggregate in type
      for (const auto agg : __type->aggregates())
        __copyAggregates(agg);

      // We add attributes in type by reference for inner ones and by copy for
      // output ones
      for (const auto attr : __type->attributes())
        __copyAttribute(attr);
    }

Here is the call graph for this function:

~PRMInstance()

template<typename GUM_SCALAR >

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

virtual

Destructor.

Definition at line 54 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__nodeIdMap, gum::prm::PRMInstance< GUM_SCALAR >::__referenceMap, and gum::prm::PRMInstance< GUM_SCALAR >::__referingAttr.

                                            {
      GUM_DESTRUCTOR(PRMInstance);

      for (const auto& elt : __nodeIdMap)
        delete elt.second;

      for (const auto& elt : __referenceMap)
        delete elt.second;

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

PRMInstance() [2/2]

template<typename GUM_SCALAR >

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

private

Copy constructor.

Definition at line 255 of file PRMInstance_tpl.h.

References GUM_ERROR.

                                                :
        PRMObject(source),
        __type(source.__type) {
      GUM_CONS_CPY(PRMInstance);
      GUM_ERROR(FatalError, "do not copy Instance");
    }

Member Function Documentation

__addReferingInstance()

template<typename GUM_SCALAR >

INLINE void gum::prm::PRMInstance< GUM_SCALAR >::__addReferingInstance ( PRMSlotChain< GUM_SCALAR > *  sc, PRMInstance< GUM_SCALAR > *  i  )

private

Add this as a referring instance over the attribute pointed by sc in i.

Parameters

sc	A slot chain pointing over an attribute in i.
i	An instance holding an attribute pointed by sc.

Definition at line 334 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__referenceMap, gum::prm::PRMInstance< GUM_SCALAR >::__referingAttr, gum::prm::PRMInstance< GUM_SCALAR >::get(), gum::prm::PRMSlotChain< GUM_SCALAR >::lastElt(), and gum::prm::PRMObject::name().

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::__instantiateSlotChain().

                                                                     {
      NodeId      id = i->get(sc->lastElt().safeName()).id();
      std::string name = sc->lastElt().safeName();

      try {
        i->__referenceMap[id]->insert(this);
        i->__referingAttr[id]->push_back(
           std::make_pair(this, sc->lastElt().safeName()));
      } catch (NotFound&) {
        i->__referenceMap.insert(id, new Set< PRMInstance< GUM_SCALAR >* >());
        i->__referenceMap[id]->insert(this);
        i->__referingAttr.insert(id, new std::vector< pair >());
        i->__referingAttr[id]->push_back(
           std::make_pair(this, sc->lastElt().safeName()));
      }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__copyAggregates()

template<typename GUM_SCALAR >

INLINE void gum::prm::PRMInstance< GUM_SCALAR >::__copyAggregates ( PRMAggregate< GUM_SCALAR > *  source )

private

Used at construction to instantiate aggregates.

Definition at line 231 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__bijection, gum::prm::PRMInstance< GUM_SCALAR >::__nodeIdMap, gum::prm::PRMAggregate< GUM_SCALAR >::buildImpl(), gum::prm::PRMClassElement< GUM_SCALAR >::id(), gum::prm::PRMObject::name(), and gum::prm::PRMAggregate< GUM_SCALAR >::type().

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

                                           {
      auto attr = new PRMScalarAttribute< GUM_SCALAR >(
         source->name(), source->type(), source->buildImpl());
      GUM_ASSERT(&(attr->type().variable()) != &(source->type().variable()));
      attr->setId(source->id());
      __nodeIdMap.insert(attr->id(), attr);
      __bijection.insert(&(source->type().variable()), &(attr->type().variable()));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__copyAttribute()

template<typename GUM_SCALAR >

INLINE void gum::prm::PRMInstance< GUM_SCALAR >::__copyAttribute ( PRMAttribute< GUM_SCALAR > *  source )

private

Used at construction to instantiate attributes.

Parameters

source

An attribute in __type.

Definition at line 242 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__bijection, gum::prm::PRMInstance< GUM_SCALAR >::__nodeIdMap, gum::prm::PRMClassElement< GUM_SCALAR >::id(), gum::prm::PRMObject::name(), and gum::prm::PRMAttribute< GUM_SCALAR >::type().

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

                                           {
      auto attr =
         new PRMScalarAttribute< GUM_SCALAR >(source->name(), source->type());
      GUM_ASSERT(&(attr->type().variable()) != &(source->type().variable()));
      // The potential is copied when instantiate() is called
      attr->cpf().fill((GUM_SCALAR)0);
      attr->setId(source->id());
      __bijection.insert(&(source->type().variable()), &(attr->type().variable()));
      __nodeIdMap.insert(attr->id(), attr);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__copyAttributeCPF()

template<typename GUM_SCALAR >

INLINE void gum::prm::PRMInstance< GUM_SCALAR >::__copyAttributeCPF ( PRMAttribute< GUM_SCALAR > *  attr )

private

Copy the content of an PRMAttribute<GUM_SCALAR> from its Class<GUM_SCALAR> counterpart.

Parameters

attr	An PRMAttribute<GUM_SCALAR> of this PRMInstance<GUM_SCALAR>.

Exceptions

OperationNotAllowed

If the MultiDimImplementation is of an unknown type.

Definition at line 603 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::bijection(), gum::prm::PRMAttribute< GUM_SCALAR >::copyCpf(), gum::prm::PRMAttribute< GUM_SCALAR >::cpf(), gum::prm::PRMClassElement< GUM_SCALAR >::safeName(), gum::prm::PRMAttribute< GUM_SCALAR >::type(), and gum::prm::PRMInstance< GUM_SCALAR >::type().

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::__doInstantiate().

                                         {
      const auto& type_attr = static_cast< const PRMAttribute< GUM_SCALAR >& >(
         type().get(attr->safeName()));
      attr->copyCpf(bijection(), type_attr);
      GUM_ASSERT(attr->cpf().contains(attr->type().variable()));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__doInstantiate()

template<typename GUM_SCALAR >

void gum::prm::PRMInstance< GUM_SCALAR >::__doInstantiate ( )

private

Starts this instance instantiations.

Definition at line 76 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__copyAttributeCPF(), gum::prm::PRMInstance< GUM_SCALAR >::__instantiateSlotChain(), gum::prm::PRMInstance< GUM_SCALAR >::__nodeIdMap, gum::prm::PRMAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMInstance< GUM_SCALAR >::getInstances(), and gum::prm::PRMInstance< GUM_SCALAR >::type().

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::instantiate().

                                                    {
      // First retrieving any referenced instance
      for (const auto chain : type().slotChains()) {
        __instantiateSlotChain(chain);
      }

      // Now we need to add referred instance to each input node
      // For Attributes we first add parents, then we initialize CPF
      for (const auto attr : type().attributes()) {
        __copyAttributeCPF(__nodeIdMap[(*attr).id()]);
      }

      // For PRMAggregate<GUM_SCALAR> we add parents
      for (const auto agg : type().aggregates()) {
        PRMAttribute< GUM_SCALAR >& attr = get(agg->safeName());

        for (const auto node : type().containerDag().parents(agg->id())) {
          try {
            attr.addParent(get(node));
          } catch (NotFound&) {
            auto        elt = &(type().get(node));
            auto        sc = static_cast< PRMSlotChain< GUM_SCALAR >* >(elt);
            const auto& instances = getInstances(sc->id());

            for (const auto inst : instances) {
              attr.addParent(inst->get(sc->lastElt().safeName()));
            }
          }
        }
      }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__instantiateSlotChain()

template<typename GUM_SCALAR >

void gum::prm::PRMInstance< GUM_SCALAR >::__instantiateSlotChain ( PRMSlotChain< GUM_SCALAR > *  sc )

private

Retrieve all instances referred by sc.

Parameters

sc	A slot chain of this instance's type.

Exceptions

NotFound

Raised if a reference in sc is not instantiated.

Definition at line 109 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__addReferingInstance(), gum::prm::PRMInstance< GUM_SCALAR >::__bijection, gum::prm::PRMInstance< GUM_SCALAR >::__referenceMap, gum::prm::PRMSlotChain< GUM_SCALAR >::chain(), gum::prm::PRMClassElement< GUM_SCALAR >::id(), gum::Set< Key, Alloc >::insert(), gum::prm::PRMSlotChain< GUM_SCALAR >::isMultiple(), gum::prm::PRMSlotChain< GUM_SCALAR >::lastElt(), and gum::prm::PRMSlotChain< GUM_SCALAR >::type().

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::__doInstantiate().

                                       {
      auto first_id = sc->chain()[0]->id();
      auto set =
         new Set< PRMInstance< GUM_SCALAR >* >(*(__referenceMap[first_id]));
      // We proceed with a width-first run of the slot chain
      for (Size idx = 1; idx < sc->chain().size() - 1; ++idx) {
        auto temp = new Set< PRMInstance< GUM_SCALAR >* >();
        for (auto current : *set) {
          auto& ref = current->type().get(sc->chain()[idx]->name());
          for (auto next : *(current->__referenceMap[ref.id()])) {
            temp->insert(next);
          }
        }
        delete set;
        set = temp;
      }

      GUM_ASSERT(set->size() > 0);
      // set contains all the instances references by sc
      if (__referenceMap.exists(sc->id())) {
        delete __referenceMap[sc->id()];
        __referenceMap[sc->id()] = set;
      } else {
        __referenceMap.insert(sc->id(), set);
      }

      // Add refering instances
      for (auto i : *set) {
        __addReferingInstance(sc, i);
      }

      // If sc is not multiple so it can be added as a parent of an attribute
      if (!sc->isMultiple()) {
        // We should have only one instance
        // Less ugly way to get the single instance in set
        for (auto instance : *set) {
          auto& attr = instance->get(sc->lastElt().safeName());
          __bijection.insert(&(sc->type().variable()), &(attr.type().variable()));
        }
      }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

add()

template<typename GUM_SCALAR >

void gum::prm::PRMInstance< GUM_SCALAR >::add	(	NodeId	id,
		PRMInstance< GUM_SCALAR > &	instance
	)

Add an PRMInstance<GUM_SCALAR> to a given PRMReferenceSlot, PRMSlotChain<GUM_SCALAR> or output node.

Three type of nodes can be associated with an PRMInstance<GUM_SCALAR>. When an PRMInstance<GUM_SCALAR> is associated with a PRMReferenceSlot, it represents an arc in the relational skeleton. For a PRMSlotChain<GUM_SCALAR>, it is a placeholder of referenced PRMClassElement by this PRMInstance<GUM_SCALAR>. Finally, for an output node it indicates that an PRMInstance<GUM_SCALAR> has an PRMClassElement referring it.

Parameters

id	The NodeId of a PRMReferenceSlot of this PRMInstance<GUM_SCALAR>.
instance	The instance added as references by id in this PRMInstance<GUM_SCALAR>.

Exceptions

WrongClassElement	Raised if id is not a valid PRMClassElement.
OutOfUpperBound	Raised if no more PRMInstance<GUM_SCALAR> can be added to id.
TypeError	Raised if instance's type isn't compatible with the reference's type.
NotFound	If there is no PRMClassElement given id.

Definition at line 153 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__referenceMap, gum::prm::PRMClassElement< GUM_SCALAR >::elt_type(), gum::prm::PRMSlotChain< GUM_SCALAR >::end(), GUM_ERROR, gum::prm::PRMInstance< GUM_SCALAR >::size(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::slotType(), and gum::prm::PRMInstance< GUM_SCALAR >::type().

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

                                                                             {
      PRMClassElement< GUM_SCALAR >* elt = 0;

      try {
        elt = &(type().get(id));
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "no ClassElement<GUM_SCALAR> matches the given id");
      }

      switch (elt->elt_type()) {
        case PRMClassElement< GUM_SCALAR >::prm_refslot: {
          PRMReferenceSlot< GUM_SCALAR >* ref =
             static_cast< PRMReferenceSlot< GUM_SCALAR >* >(elt);

          // Checking if instance's type is legal
          if (!instance.type().isSubTypeOf(ref->slotType())) {
            GUM_ERROR(TypeError,
                      "given Instance type is not a proper "
                      "subclass of the ReferenceSlot<GUM_SCALAR> slot type");
          }

          // Checking the reference's size limit
          if (__referenceMap.exists(id)
              && (!static_cast< PRMReferenceSlot< GUM_SCALAR >& >(type().get(id))
                      .isArray())
              && (__referenceMap[id]->size() == 1)) {
            GUM_ERROR(OutOfUpperBound,
                      "ReferenceSlot<GUM_SCALAR> size limit reached");
          }

          break;
        }

        case PRMClassElement< GUM_SCALAR >::prm_slotchain: {
          PRMSlotChain< GUM_SCALAR >& sc =
             static_cast< PRMSlotChain< GUM_SCALAR >& >(type().get(id));

          // Checking if instance's type is legal
          if (!instance.type().isSubTypeOf(sc.end())) {
            GUM_ERROR(TypeError,
                      "given Instance type is not a proper "
                      "subclass of the ClassElementContainer pointed"
                      " by the SlotChain<GUM_SCALAR>");
          }

          // Checking the reference's size limit
          if (__referenceMap.exists(id)
              && (!static_cast< PRMSlotChain< GUM_SCALAR >& >(type().get(id))
                      .isMultiple())
              && (__referenceMap[id]->size() == 1)) {
            GUM_ERROR(OutOfUpperBound, "SlotChain<GUM_SCALAR> size limit reached");
          }

          break;
        }

        default: {
          if (!type().isOutputNode(*elt)) {
            GUM_ERROR(WrongClassElement,
                      "given ClassElement<GUM_SCALAR> is not an output node");
          }
        }
      }

      if (!__referenceMap.exists(id)) {
        __referenceMap.insert(id, new Set< PRMInstance< GUM_SCALAR >* >());
      }

      __referenceMap[id]->insert(&instance);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

begin() [1/4]

template<typename GUM_SCALAR >

INLINE PRMInstance< GUM_SCALAR >::iterator gum::prm::PRMInstance< GUM_SCALAR >::begin

(

)

Returns an iterator at the begining of the list of gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 389 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__nodeIdMap.

Referenced by gum::prm::SVE< GUM_SCALAR >::__eliminateNodes(), gum::prm::StructuredInference< GUM_SCALAR >::__reduceAloneInstances(), and gum::prm::StructuredInference< GUM_SCALAR >::searchPatterns().

                                        {
      return __nodeIdMap.begin();
    }

Here is the caller graph for this function:

begin() [2/4]

template<typename GUM_SCALAR >

INLINE PRMInstance< GUM_SCALAR >::const_iterator gum::prm::PRMInstance< GUM_SCALAR >::begin

(

)

const

Returns an iterator at the beginning of the list of gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 401 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__nodeIdMap.

                                              {
      return __nodeIdMap.begin();
    }

begin() [3/4]

template<typename GUM_SCALAR >

INLINE PRMInstance< GUM_SCALAR >::RefIterator gum::prm::PRMInstance< GUM_SCALAR >::begin

(

NodeId

id

)

Returns an iterator at the beginning of the set of PRMInstance<GUM_SCALAR> associated to a given gum::prm::PRMReferenceSlot or gum::prm::PRMSlotChain<GUM_SCALAR>.

Parameters

id	A gum::prm::PRMReferenceSlot or gum::prm::PRMSlotChain<GUM_SCALAR> in this PRMInstance<GUM_SCALAR> type.

Exceptions

NotFound	Raised if no gum::prm::PRMClassElement in this PRMInstance<GUM_SCALAR> type matches id.
WrongClassElement	Raised if id is neither a PRMReferenceSlot or PRMSlotChain<GUM_SCALAR>.

Definition at line 413 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__referenceMap, and GUM_ERROR.

                                                 {
      try {
        return PRMInstance< GUM_SCALAR >::RefIterator(*(__referenceMap[id]));
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "no referred instances from this NodeId");
      }
    }

begin() [4/4]

template<typename GUM_SCALAR >

INLINE PRMInstance< GUM_SCALAR >::RefConstIterator gum::prm::PRMInstance< GUM_SCALAR >::begin

(

NodeId

id

)

const

Returns an iterator at the beginning of the set of PRMInstance<GUM_SCALAR> associated to a given gum::prm::PRMReferenceSlot or gum::prm::PRMSlotChain<GUM_SCALAR>.

Parameters

id	A gum::prm::PRMReferenceSlot or gum::prm::PRMSlotChain<GUM_SCALAR> in this PRMInstance<GUM_SCALAR> type.

Exceptions

NotFound	Raised if no gum::prm::PRMClassElement in this PRMInstance<GUM_SCALAR> type matches id.
WrongClassElement	Raised if id is neither a PRMReferenceSlot or PRMSlotChain<GUM_SCALAR>.

Definition at line 423 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__referenceMap, and GUM_ERROR.

                                                       {
      try {
        return PRMInstance< GUM_SCALAR >::RefConstIterator(*(__referenceMap[id]));
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "no referred instances from this NodeId");
      }
    }

beginInvRef() [1/2]

template<typename GUM_SCALAR >

INLINE PRMInstance< GUM_SCALAR >::InvRefIterator gum::prm::PRMInstance< GUM_SCALAR >::beginInvRef

(

)

Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 562 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__referingAttr.

Referenced by gum::prm::SVE< GUM_SCALAR >::__eliminateNodes(), gum::prm::SVE< GUM_SCALAR >::__eliminateNodesDownward(), and gum::prm::SVE< GUM_SCALAR >::__eliminateNodesUpward().

                                              {
      return __referingAttr.begin();
    }

Here is the caller graph for this function:

beginInvRef() [2/2]

template<typename GUM_SCALAR >

INLINE PRMInstance< GUM_SCALAR >::InvRefConstIterator gum::prm::PRMInstance< GUM_SCALAR >::beginInvRef

(

)

const

Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 574 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__referingAttr.

                                                    {
      return __referingAttr.begin();
    }

bijection()

template<typename GUM_SCALAR >

INLINE const Bijection< const DiscreteVariable *, const DiscreteVariable *> & gum::prm::PRMInstance< GUM_SCALAR >::bijection

(

)

const

Returns a mapping between DiscreteVariable used in this and the ones used in this PRMInstance<GUM_SCALAR>'s Class<GUM_SCALAR>.

MultiDims require distinctive DiscreteVariable pointers, thus interface attributes are always instantiated to prevent multiple insertion of the same DiscreteVariable pointer in a MultiDim.

Returns

Returns a bijection in which first elements are DiscreteVariable in this->type() and the second are in this.

Definition at line 354 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__bijection.

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::__copyAttributeCPF(), gum::prm::SVED< GUM_SCALAR >::__insertLiftedNodes(), gum::prm::SVE< GUM_SCALAR >::__insertLiftedNodes(), and gum::prm::StructuredInference< GUM_SCALAR >::__reduceAloneInstances().

                                                            {
      return __bijection;
    }

Here is the caller graph for this function:

end() [1/2]

template<typename GUM_SCALAR >

INLINE const PRMInstance< GUM_SCALAR >::iterator & gum::prm::PRMInstance< GUM_SCALAR >::end

(

)

Returns a reference over the iterator at the end of the list of gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 395 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__nodeIdMap.

Referenced by gum::prm::SVE< GUM_SCALAR >::__eliminateNodes(), and gum::prm::StructuredInference< GUM_SCALAR >::__reduceAloneInstances().

                                      {
      return __nodeIdMap.end();
    }

Here is the caller graph for this function:

end() [2/2]

template<typename GUM_SCALAR >

INLINE const PRMInstance< GUM_SCALAR >::const_iterator & gum::prm::PRMInstance< GUM_SCALAR >::end

(

)

const

Returns a reference over the iterator at the end of the list of gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 407 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__nodeIdMap.

                                            {
      return __nodeIdMap.end();
    }

endInvRef() [1/2]

template<typename GUM_SCALAR >

INLINE const PRMInstance< GUM_SCALAR >::InvRefIterator & gum::prm::PRMInstance< GUM_SCALAR >::endInvRef

(

)

Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 568 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__referingAttr.

Referenced by gum::prm::SVE< GUM_SCALAR >::__eliminateNodes(), gum::prm::SVE< GUM_SCALAR >::__eliminateNodesDownward(), and gum::prm::SVE< GUM_SCALAR >::__eliminateNodesUpward().

                                            {
      return __referingAttr.end();
    }

Here is the caller graph for this function:

endInvRef() [2/2]

template<typename GUM_SCALAR >

INLINE const PRMInstance< GUM_SCALAR >::InvRefConstIterator & gum::prm::PRMInstance< GUM_SCALAR >::endInvRef

(

)

const

Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 580 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__referingAttr.

                                                  {
      return __referingAttr.end();
    }

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.

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:

exists() [1/2]

template<typename GUM_SCALAR >

INLINE bool gum::prm::PRMInstance< GUM_SCALAR >::exists

(

NodeId

id

)

const

Returns true if id matches an PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 285 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__nodeIdMap.

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::exists(), and gum::prm::o3prmr::O3prmrInterpreter::findAttributeName().

                                                                 {
      return __nodeIdMap.exists(id);
    }

Here is the caller graph for this function:

exists() [2/2]

template<typename GUM_SCALAR >

INLINE bool gum::prm::PRMInstance< GUM_SCALAR >::exists

(

const std::string &

name

)

const

Returns true if name matches an PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 290 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__type, and gum::prm::PRMInstance< GUM_SCALAR >::exists().

                                                                             {
      return __type->exists(name) && exists(__type->get(name).id());
    }

Here is the call graph for this function:

get() [1/4]

template<typename GUM_SCALAR >

INLINE PRMAttribute< GUM_SCALAR > & gum::prm::PRMInstance< GUM_SCALAR >::get

(

NodeId

id

)

Getter on an PRMAttribute<GUM_SCALAR> of this PRMInstance<GUM_SCALAR>.

Recall that PRMAggregate<GUM_SCALAR> are instantiated as PRMAttribute<GUM_SCALAR> when an PRMInstance<GUM_SCALAR> is created. Thus any random variable contained in this PRMInstance<GUM_SCALAR> is mapped to an PRMAttribute<GUM_SCALAR>.

Parameters

id	The PRMAttribute<GUM_SCALAR> id.

Returns

Returns a constant reference on an PRMAttribute<GUM_SCALAR>.

Exceptions

NotFound

Raised if no PRMAttribute<GUM_SCALAR> matches name.

Definition at line 295 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__nodeIdMap, and GUM_ERROR.

Referenced by gum::prm::SVE< GUM_SCALAR >::__addDelayedVariable(), gum::prm::PRMInstance< GUM_SCALAR >::__addReferingInstance(), gum::prm::SVED< GUM_SCALAR >::__eliminateNodes(), gum::prm::SVE< GUM_SCALAR >::__eliminateNodesWithEvidence(), gum::prm::SVED< GUM_SCALAR >::__getAggPotential(), gum::prm::SVE< GUM_SCALAR >::__getAggPotential(), gum::prm::PRMSystem< double >::__groundAttr(), gum::prm::PRMSystem< double >::__groundPotential(), gum::prm::InstanceBayesNet< GUM_SCALAR >::__init(), gum::prm::StructuredInference< GUM_SCALAR >::__insertNodeInElimLists(), gum::prm::StructuredBayesBall< GUM_SCALAR >::__isHardEvidence(), gum::prm::StructuredInference< GUM_SCALAR >::__reduceAloneInstances(), gum::prm::o3prmr::O3prmrInterpreter::checkObserve(), gum::prm::o3prmr::O3prmrInterpreter::checkQuery(), and gum::prm::o3prmr::O3prmrInterpreter::checkUnobserve().

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

Here is the caller graph for this function:

get() [2/4]

template<typename GUM_SCALAR >

INLINE PRMAttribute< GUM_SCALAR > & gum::prm::PRMInstance< GUM_SCALAR >::get

(

const std::string &

name

)

Given a name returns the related PRMAttribute<GUM_SCALAR>.

Parameters

name	The PRMAttribute<GUM_SCALAR>'s name.

Returns

Returns a reference over the PRMAttribute<GUM_SCALAR>.

Exceptions

NotFound

Raised if there is no PRMAttribute<GUM_SCALAR> named n.

Definition at line 315 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__nodeIdMap, GUM_ERROR, and gum::prm::PRMInstance< GUM_SCALAR >::type().

                                                               {
      try {
        return *(__nodeIdMap[type().get(name).id()]);
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "no PRMAttribute<GUM_SCALAR> with the given name");
      }
    }

Here is the call graph for this function:

get() [3/4]

template<typename GUM_SCALAR >

INLINE const PRMAttribute< GUM_SCALAR > & gum::prm::PRMInstance< GUM_SCALAR >::get

(

NodeId

id

)

const

Getter on an PRMAttribute<GUM_SCALAR> of this PRMInstance<GUM_SCALAR>.

Recall that PRMAggregate<GUM_SCALAR> are instantiated has PRMAttribute<GUM_SCALAR> when an PRMInstance<GUM_SCALAR> is created. Thus any random variable contained in this PRMInstance<GUM_SCALAR> is mapped to an PRMAttribute<GUM_SCALAR>.

Parameters

id	The PRMAttribute<GUM_SCALAR> id.

Returns

Returns a constant reference on an PRMAttribute<GUM_SCALAR>.

Exceptions

NotFound

Raised if no PRMAttribute<GUM_SCALAR> matches name.

Definition at line 305 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__nodeIdMap, and GUM_ERROR.

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

get() [4/4]

template<typename GUM_SCALAR >

INLINE const PRMAttribute< GUM_SCALAR > & gum::prm::PRMInstance< GUM_SCALAR >::get

(

const std::string &

name

)

const

Given a name returns the related PRMClassElement.

Parameters

name	The PRMClassElement's name.

Returns

Returns a constant reference over the PRMClassElement.

Exceptions

NotFound

Raised if there is no PRMClassElement named n.

Definition at line 325 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__nodeIdMap, GUM_ERROR, and gum::prm::PRMInstance< GUM_SCALAR >::type().

                                                                           {
      try {
        return *(__nodeIdMap[type().get(name).id()]);
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "no PRMAttribute<GUM_SCALAR> with the given name");
      }
    }

Here is the call graph for this function:

getInstance()

template<typename GUM_SCALAR >

INLINE const PRMInstance< GUM_SCALAR > & gum::prm::PRMInstance< GUM_SCALAR >::getInstance

(

NodeId

id

)

const

Fast access to the first instance in a PRMReferenceSlot or PRMSlotChain<GUM_SCALAR>.

This is equivalent to **(this->getInstance(id).begin()) and should be use when dealing with non multiple PRMReferenceSlot or PRMSlotChain<GUM_SCALAR>.

Parameters

id	The NodeId of a PRMReferenceSlot or PRMSlotChain<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Exceptions

NotFound	Raised if there is no PRMClassElement given id.
UndefinedElement	Raised if no PRMInstance<GUM_SCALAR> are referenced by id.

Definition at line 360 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__referenceMap, GUM_ERROR, and gum::prm::PRMInstance< GUM_SCALAR >::size().

Referenced by gum::prm::PRMSystem< double >::__groundPotential().

                                                                       {
      try {
        if (__referenceMap[id]->size() > 0) {
          return **(__referenceMap[id]->begin());
        } else {
          GUM_ERROR(UndefinedElement,
                    "no Instance associated with the given NodeId");
        }
      } catch (NotFound&) {
        GUM_ERROR(NotFound,
                  "no ReferenceSlot<GUM_SCALAR> or SlotChain<GUM_SCALAR> "
                  "matches the given NodeId");
      }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInstances()

template<typename GUM_SCALAR >

INLINE const Set< PRMInstance< GUM_SCALAR > *> & gum::prm::PRMInstance< GUM_SCALAR >::getInstances

(

NodeId

id

)

const

Returns the Set of PRMInstance<GUM_SCALAR> referenced by id.

Parameters

id	The NodeId of a PRMReferenceSlot or PRMSlotChain<GUM_SCALAR> in this.

Returns

Returns the Set of PRMInstance<GUM_SCALAR> referenced by id.

Exceptions

NotFound

If there is no PRMClassElement given id.

Definition at line 377 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__referenceMap, and GUM_ERROR.

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::__doInstantiate(), gum::prm::SVED< GUM_SCALAR >::__eliminateNodes(), gum::prm::SVE< GUM_SCALAR >::__eliminateNodes(), gum::prm::SVED< GUM_SCALAR >::__eliminateNodesDownward(), gum::prm::SVE< GUM_SCALAR >::__eliminateNodesDownward(), gum::prm::SVED< GUM_SCALAR >::__eliminateNodesUpward(), gum::prm::SVE< GUM_SCALAR >::__eliminateNodesUpward(), and gum::prm::StructuredBayesBall< GUM_SCALAR >::__fromChild().

                                                                        {
      try {
        return *(__referenceMap[id]);
      } catch (NotFound&) {
        GUM_ERROR(NotFound,
                  "no ReferenceSlot<GUM_SCALAR> or SlotChain<GUM_SCALAR> "
                  "matches the given NodeId");
      }
    }

Here is the caller graph for this function:

getRefAttr() [1/2]

template<typename GUM_SCALAR >

INLINE std::vector< std::pair< PRMInstance< GUM_SCALAR > *, std::string > > & gum::prm::PRMInstance< GUM_SCALAR >::getRefAttr

(

NodeId

id

)

Returns a vector of pairs of refering attributes of id.

Definition at line 586 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__referingAttr.

Referenced by gum::prm::SVED< GUM_SCALAR >::__eliminateNodes(), gum::prm::SVED< GUM_SCALAR >::__eliminateNodesDownward(), gum::prm::SVED< GUM_SCALAR >::__eliminateNodesUpward(), gum::prm::StructuredBayesBall< GUM_SCALAR >::__fromChild(), gum::prm::StructuredBayesBall< GUM_SCALAR >::__fromParent(), and gum::prm::StructuredInference< GUM_SCALAR >::__insertNodeInElimLists().

                                                          {
      return *(__referingAttr[id]);
    }

Here is the caller graph for this function:

getRefAttr() [2/2]

template<typename GUM_SCALAR >

INLINE const std::vector< std::pair< PRMInstance< GUM_SCALAR > *, std::string > > & gum::prm::PRMInstance< GUM_SCALAR >::getRefAttr

(

NodeId

id

)

const

Returns a vector of pairs of refering attributes of id.

Definition at line 593 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__referingAttr.

                                                            {
      return *(__referingAttr[id]);
    }

hasRefAttr()

template<typename GUM_SCALAR >

INLINE bool gum::prm::PRMInstance< GUM_SCALAR >::hasRefAttr

(

NodeId

id

)

const

Returns true if id has at least one referring PRMAttribute<GUM_SCALAR>.

Parameters

id

A NodeId.

Returns

returns true if is has at least one referring PRMAttribute<GUM_SCALAR>.

Definition at line 598 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__referingAttr.

                                                                     {
      return __referingAttr.exists(id) && (!__referingAttr[id]->empty());
    }

instantiate()

template<typename GUM_SCALAR >

void gum::prm::PRMInstance< GUM_SCALAR >::instantiate

(

)

Instantiate all nodes which requires it.

All attributes are now instantiated, which means they have a different DiscreteVariable pointer. This methods however still connects attributes of different instance together.

Warning

Be aware that this method will delete a large part of this instance attribute's CPF. Furthermore, the instantiated attribute's type will change (but will not be deleted).

Definition at line 68 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__doInstantiate(), and gum::prm::PRMInstance< GUM_SCALAR >::__instantiated.

                                                {
      if (!__instantiated) {
        __instantiated = true;
        __doInstantiate();
      }
    }

Here is the call graph for this function:

isClass()

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

inlinestaticinherited

Returns true if obj_ptr is of type Class.

Definition at line 102 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 112 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 107 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:

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.

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 35 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 39 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:

obj_type()

template<typename GUM_SCALAR >

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

virtual

Returns the PRM type of this object.

Implements gum::prm::PRMObject.

Definition at line 270 of file PRMInstance_tpl.h.

References gum::prm::PRMObject::INSTANCE.

                                                                       {
      return PRMObject::prm_type::INSTANCE;
    }

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 49 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 PRMInstance< GUM_SCALAR > & gum::prm::PRMInstance< GUM_SCALAR >::operator= ( const PRMClass< GUM_SCALAR > &  from )

private

Copy operator. Don't use it.

Definition at line 265 of file PRMInstance_tpl.h.

References GUM_ERROR.

                                                                              {
      GUM_ERROR(FatalError, "do not copy Instance");
    }

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

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.

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:

size()

template<typename GUM_SCALAR >

INLINE Size gum::prm::PRMInstance< GUM_SCALAR >::size

(

)

const

Returns the number of attributes in this PRMInstance<GUM_SCALAR>.

Returns

the number of attributes in this PRMInstance<GUM_SCALAR>.

Definition at line 226 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::__nodeIdMap.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::__reduceAloneInstances(), gum::prm::PRMInstance< GUM_SCALAR >::add(), and gum::prm::PRMInstance< GUM_SCALAR >::getInstance().

                                                      {
      return __nodeIdMap.size();
    }

Here is the caller graph for this function:

type() [1/2]

template<typename GUM_SCALAR >

INLINE PRMClass< GUM_SCALAR > & gum::prm::PRMInstance< GUM_SCALAR >::type

(

)

Returns the type of this instance.

Definition at line 275 of file PRMInstance_tpl.h.

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

Referenced by gum::prm::StructuredBayesBall< GUM_SCALAR >::__buildHashKey(), gum::prm::SVED< GUM_SCALAR >::__checkElimOrder(), gum::prm::SVE< GUM_SCALAR >::__checkElimOrder(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAttributeCPF(), gum::prm::PRMInstance< GUM_SCALAR >::__doInstantiate(), gum::prm::SVE< GUM_SCALAR >::__eliminateNodes(), gum::prm::SVED< GUM_SCALAR >::__eliminateNodesDownward(), gum::prm::SVE< GUM_SCALAR >::__eliminateNodesDownward(), gum::prm::SVED< GUM_SCALAR >::__eliminateNodesUpward(), gum::prm::SVE< GUM_SCALAR >::__eliminateNodesUpward(), gum::prm::SVE< GUM_SCALAR >::__eliminateNodesWithEvidence(), gum::prm::StructuredBayesBall< GUM_SCALAR >::__fromChild(), gum::prm::StructuredBayesBall< GUM_SCALAR >::__fromParent(), gum::prm::StructuredBayesBall< GUM_SCALAR >::__getSC(), gum::prm::PRMSystem< double >::__groundAttr(), gum::prm::PRMSystem< double >::__groundPotential(), gum::prm::InstanceBayesNet< GUM_SCALAR >::__init(), gum::prm::SVED< GUM_SCALAR >::__initLiftedNodes(), gum::prm::SVED< GUM_SCALAR >::__initReqSets(), gum::prm::SVE< GUM_SCALAR >::__insertLiftedNodes(), gum::prm::StructuredInference< GUM_SCALAR >::__insertNodeInElimLists(), gum::prm::__print_attribute__(), gum::prm::StructuredInference< GUM_SCALAR >::__reduceAloneInstances(), gum::prm::SVE< GUM_SCALAR >::__variableElimination(), gum::prm::PRMSystem< double >::add(), gum::prm::PRMInstance< GUM_SCALAR >::add(), and gum::prm::PRMInstance< GUM_SCALAR >::get().

                                                                   {
      return *__type;
    }

Here is the caller graph for this function:

type() [2/2]

template<typename GUM_SCALAR >

INLINE const PRMClass< GUM_SCALAR > & gum::prm::PRMInstance< GUM_SCALAR >::type

(

)

const

Returns the type of this instance.

Definition at line 280 of file PRMInstance_tpl.h.

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

                                                                               {
      return *__type;
    }

Member Data Documentation

__bijection

template<typename GUM_SCALAR>

Bijection< const DiscreteVariable*, const DiscreteVariable* > gum::prm::PRMInstance< GUM_SCALAR >::__bijection

private

A bijection used for MultiDim handling.

Definition at line 529 of file PRMInstance.h.

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::__copyAggregates(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAttribute(), gum::prm::PRMInstance< GUM_SCALAR >::__instantiateSlotChain(), and gum::prm::PRMInstance< GUM_SCALAR >::bijection().

__instantiated

template<typename GUM_SCALAR>

bool gum::prm::PRMInstance< GUM_SCALAR >::__instantiated

private

True if this instance has been instantiated.

Definition at line 507 of file PRMInstance.h.

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::instantiate().

__nodeIdMap

template<typename GUM_SCALAR>

NodeProperty< PRMAttribute< GUM_SCALAR >* > gum::prm::PRMInstance< GUM_SCALAR >::__nodeIdMap

private

The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM_SCALAR>.

Definition at line 514 of file PRMInstance.h.

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::__copyAggregates(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAttribute(), gum::prm::PRMInstance< GUM_SCALAR >::__doInstantiate(), gum::prm::PRMInstance< GUM_SCALAR >::begin(), gum::prm::PRMInstance< GUM_SCALAR >::end(), gum::prm::PRMInstance< GUM_SCALAR >::exists(), gum::prm::PRMInstance< GUM_SCALAR >::get(), gum::prm::PRMInstance< GUM_SCALAR >::size(), and gum::prm::PRMInstance< GUM_SCALAR >::~PRMInstance().

__referenceMap

template<typename GUM_SCALAR>

NodeProperty< Set< PRMInstance< GUM_SCALAR >* >* > gum::prm::PRMInstance< GUM_SCALAR >::__referenceMap

private

Mapping between the gum::prm::PRMReferenceSlot and gum::prm::PRMSlotChain<GUM_SCALAR> in __type / and the PRMInstance<GUM_SCALAR> associated with it.

Definition at line 519 of file PRMInstance.h.

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::__addReferingInstance(), gum::prm::PRMInstance< GUM_SCALAR >::__instantiateSlotChain(), gum::prm::PRMInstance< GUM_SCALAR >::add(), gum::prm::PRMInstance< GUM_SCALAR >::begin(), gum::prm::PRMInstance< GUM_SCALAR >::getInstance(), gum::prm::PRMInstance< GUM_SCALAR >::getInstances(), and gum::prm::PRMInstance< GUM_SCALAR >::~PRMInstance().

__referingAttr

template<typename GUM_SCALAR>

NodeProperty< std::vector< pair >* > gum::prm::PRMInstance< GUM_SCALAR >::__referingAttr

private

The set of pair (instance, attribute) referring an attribute of this instance.

Definition at line 526 of file PRMInstance.h.

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::__addReferingInstance(), gum::prm::PRMInstance< GUM_SCALAR >::beginInvRef(), gum::prm::PRMInstance< GUM_SCALAR >::endInvRef(), gum::prm::PRMInstance< GUM_SCALAR >::getRefAttr(), gum::prm::PRMInstance< GUM_SCALAR >::hasRefAttr(), and gum::prm::PRMInstance< GUM_SCALAR >::~PRMInstance().

__type

template<typename GUM_SCALAR>

PRMClass< GUM_SCALAR >* gum::prm::PRMInstance< GUM_SCALAR >::__type

private

The type of this PRMInstance<GUM_SCALAR>.

Definition at line 510 of file PRMInstance.h.

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::exists(), gum::prm::PRMInstance< GUM_SCALAR >::PRMInstance(), and gum::prm::PRMInstance< GUM_SCALAR >::type().

---

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

• agrum/PRM/elements/PRMInstance.h
• agrum/PRM/elements/PRMInstance_tpl.h