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

A PRMSystem is a container of PRMInstance and describe a relational skeleton. More...

#include <PRMObject.h>

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

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

Public Member Functions
Constructors & destructor.
	PRMSystem (const std::string &name)
	Default constructor. More...
virtual	~PRMSystem ()
	Destructor. More...
Getters & setters over the relational skeleton.
const DiGraph &	skeleton () const
	Returns the relation skeleton of this PRMSystem. More...
PRMInstance< GUM_SCALAR > &	get (NodeId id)
	Returns an PRMInstance given it's NodeId in the relational skeleton. More...
const PRMInstance< GUM_SCALAR > &	get (NodeId id) const
	Returns an PRMInstance given it's NodeId in the relational skeleton. More...
NodeId	get (const PRMInstance< GUM_SCALAR > &i) const
	Returns the relation skeleton of this PRMSystem. More...
Getters & setters over PRMInstance and array of PRMInstance.
virtual PRMObject::prm_type	obj_type () const
	Returns the PRM type of this object. More...
Size	size () const
	Returns the number of PRMInstance in this PRMSystem. More...
bool	exists (const std::string &name) const
	Retruns true either if name is an instance or an array in this PRMSystem. More...
bool	isInstantiated (const PRMClass< GUM_SCALAR > &c) const
	Returns true if the given Class<GUM_SCALAR> has at least one PRMInstance in this PRMSystem. More...
bool	isInstance (const std::string &name) const
	Returns true if an PRMInstance with the given name exists. More...
bool	isArray (const std::string &name) const
	Returns true if an array with the given name exists. More...
void	groundedBN (BayesNetFactory< GUM_SCALAR > &factory) const
	Returns the grounded Bayesian network of this system. More...
void	instantiate ()
	Instantiate all the PRMInstance in this PRMSystem. More...
PRMInstance handling.
PRMInstance< GUM_SCALAR > &	get (const std::string &name)
	Returns a reference over an PRMInstance given it's name. More...
const PRMInstance< GUM_SCALAR > &	get (const std::string &name) const
	Returns a constant reference over an PRMInstance given it's name. More...
const Set< PRMInstance< GUM_SCALAR > *> &	get (const PRMClass< GUM_SCALAR > &type) const
	Returns the sequence of all instances of the given type. More...
NodeId	add (PRMInstance< GUM_SCALAR > *i)
	Add an PRMInstance to this system. More...
Array handling.
const Sequence< PRMInstance< GUM_SCALAR > *> &	getArray (const std::string &name) const
	Returns the sequence of instances of a given array. More...
PRMClassElementContainer< GUM_SCALAR > &	getArrayType (const std::string &name)
	Returns the type of the given array. More...
const PRMClassElementContainer< GUM_SCALAR > &	getArrayType (const std::string &name) const
	Returns the type of the given array. More...
NodeId	add (const std::string &array, PRMInstance< GUM_SCALAR > *i)
	Add an PRMInstance to an array in this system. If the array doesn't exists it is created. More...
NodeId	add (const std::string &array, PRMInstance< GUM_SCALAR > &i)
	Add an PRMInstance to an array in this system. If the array doesn't exists it is created. More...
void	addArray (const std::string &array, PRMClassElementContainer< GUM_SCALAR > &type)
	Add an array of instances in this system. If the array doesn't exists it is created. More...
Getters & setters.
const std::string &	name () const
	Returns the name of this object. More...
void	name (const std::string &name)
	Change the name of the PRM Object. More...
Operators
bool	operator== (const PRMObject &obj) const
	To PRMObject are equal if they have the same name (which is unique). More...
bool	operator!= (const PRMObject &obj) const
	To PRMObject are equal if they have the same name (which is unique). More...

Protected Member Functions
	PRMSystem (const PRMSystem< GUM_SCALAR > &from)
	Copy constructor. Don't use it. More...
PRMSystem< GUM_SCALAR > &	operator= (const PRMSystem< GUM_SCALAR > &from)=delete
	Copy operator. Don't use it. More...
Ground BN private methods.
void	_groundRef_ (const PRMInstance< GUM_SCALAR > &instance, BayesNetFactory< GUM_SCALAR > &factory) const
	Method which ground PRMReferenceSlot of an PRMInstance and add arcs in the IBayesNet. More...
void	_groundAttr_ (const PRMInstance< GUM_SCALAR > &instance, BayesNetFactory< GUM_SCALAR > &factory) const
	Method which ground Atttributes and Aggregators of an PRMInstance. More...
void	_groundPotential_ (const PRMInstance< GUM_SCALAR > &instance, const PRMAttribute< GUM_SCALAR > &attr, BayesNetFactory< GUM_SCALAR > &factory) const
	Method which copy node's Potential of an PRMInstance to the grounded Bayesian network. More...
void	_groundAgg_ (const PRMClassElement< GUM_SCALAR > &elt, const std::string &name, BayesNetFactory< GUM_SCALAR > &factory) const
	Ground an aggregator with the given name in the grounded IBayesNet. 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...

Iterators.
typedef NodeProperty< PRMInstance< GUM_SCALAR > *>::iterator	iterator
	Iterator over the PRMInstance of this PRMSystem. More...
typedef NodeProperty< PRMInstance< GUM_SCALAR > *>::const_iterator	const_iterator
	Constant Iterator over the PRMInstance of this PRMSystem. More...
typedef Sequence< PRMInstance< GUM_SCALAR > *>::iterator	array_iterator
	Iterator over the PRMInstance in an array in this PRMSystem. More...
typedef Sequence< PRMInstance< GUM_SCALAR > *>::const_iterator	const_array_iterator
	Iterator over the PRMInstance in an array in this PRMSystem. More...
iterator	begin ()
	Returns an iterator over the instances in this system. More...
const iterator &	end ()
	Returns a iterator at the end of the set of PRMInstance in this PRMSystem. More...
const_iterator	begin () const
	Returns a constant iterator over the instances in this system. More...
const const_iterator &	end () const
	Returns a constant iterator at the end of the set of PRMInstance in this PRMSystem. More...
array_iterator	begin (const std::string &a)
	Returns an iterator at the beginning of the Sequence of PRMInstance in the array named a;. More...
const array_iterator &	end (const std::string &a)
	Returns an iterator at the end of the Sequence of PRMInstance in the array named a. More...
const_array_iterator	begin (const std::string &a) const
	Returns an iterator at the beginning of the Sequence of PRMInstance in the array named a;. More...
const const_array_iterator &	end (const std::string &a) const
	Returns an iterator at the end of the Sequence of PRMInstance in the array named a. More...

Private PRMInstance handling methods and members.
typedef std::pair< PRMClassElementContainer< GUM_SCALAR > *, Sequence< PRMInstance< GUM_SCALAR > *> *>	model_pair
	Typedef of the pair of a Class<GUM_SCALAR> and the sequence of it's instantiation. More...
DiGraph	skeleton_
	The relational skeleton of this PRMSystem. More...
NodeProperty< PRMInstance< GUM_SCALAR > *>	nodeIdMap_
	The mapping between PRMInstance and their NodeId in the relational skeleton of this PRMSystem. More...
HashTable< std::string, PRMInstance< GUM_SCALAR > *>	nameMap_
	The mapping between PRMInstance and their names. More...
HashTable< PRMClass< GUM_SCALAR > *, Set< PRMInstance< GUM_SCALAR > *> *>	instanceMap_
	Mapping between a class and all it's PRMInstance in this system. More...
HashTable< std::string, model_pair >	arrayMap_
	Mapping between arrays and their name. The first element of the pair is the type of the array. More...

Detailed Description

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

A PRMSystem is a container of PRMInstance and describe a relational skeleton.

Definition at line 234 of file PRMObject.h.

Member Typedef Documentation

array_iterator

template<typename GUM_SCALAR>

typedef Sequence< PRMInstance< GUM_SCALAR >* >::iterator gum::prm::PRMSystem< GUM_SCALAR >::array_iterator

Iterator over the PRMInstance in an array in this PRMSystem.

Definition at line 224 of file PRMSystem.h.

const_array_iterator

template<typename GUM_SCALAR>

typedef Sequence< PRMInstance< GUM_SCALAR >* >::const_iterator gum::prm::PRMSystem< GUM_SCALAR >::const_array_iterator

Iterator over the PRMInstance in an array in this PRMSystem.

Definition at line 237 of file PRMSystem.h.

const_iterator

template<typename GUM_SCALAR>

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

Constant Iterator over the PRMInstance of this PRMSystem.

Definition at line 214 of file PRMSystem.h.

iterator

template<typename GUM_SCALAR>

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

Iterator over the PRMInstance of this PRMSystem.

Definition at line 204 of file PRMSystem.h.

model_pair

template<typename GUM_SCALAR>

typedef std::pair< PRMClassElementContainer< GUM_SCALAR >*, Sequence< PRMInstance< GUM_SCALAR >* >* > gum::prm::PRMSystem< GUM_SCALAR >::model_pair

protected

Typedef of the pair of a Class<GUM_SCALAR> and the sequence of it's instantiation.

Definition at line 279 of file PRMSystem.h.

Member Enumeration Documentation

prm_type

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

stronginherited

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

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

Enumerator
ALL
CLASS
PRM_INTERFACE
CLASS_ELT
TYPE
SYSTEM
INSTANCE

Definition at line 68 of file PRMObject.h.

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

Constructor & Destructor Documentation

PRMSystem() [1/2]

template<typename GUM_SCALAR >

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

explicit

Default constructor.

Definition at line 41 of file PRMSystem_tpl.h.

                                                            : PRMObject(name) {
      GUM_CONSTRUCTOR(PRMSystem);
    }

~PRMSystem()

template<typename GUM_SCALAR >

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

virtual

Destructor.

Definition at line 46 of file PRMSystem_tpl.h.

                                        {
      GUM_DESTRUCTOR(PRMSystem);

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

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

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

PRMSystem() [2/2]

template<typename GUM_SCALAR>

INLINE gum::prm::PRMSystem< GUM_SCALAR >::PRMSystem ( const PRMSystem< GUM_SCALAR > &  from )

protected

Copy constructor. Don't use it.

Definition at line 60 of file PRMSystem_tpl.h.

                                                                   :
        PRMObject(from), skeleton_(from.skeleton_), nodeIdMap_(from.nodeIdMap_),
        nameMap_(from.nameMap_), instanceMap_(from.instanceMap_), arrayMap_(from.arrayMap_) {
      GUM_CONS_CPY(PRMSystem);
    }

Member Function Documentation

_groundAgg_()

template<typename GUM_SCALAR>

void gum::prm::PRMSystem< GUM_SCALAR >::_groundAgg_ ( const PRMClassElement< GUM_SCALAR > &  elt, const std::string &  name, BayesNetFactory< GUM_SCALAR > &  factory  ) const

protected

Ground an aggregator with the given name in the grounded IBayesNet.

Parameters

elt	The aggregator grounded.
name	The aggregator's name in the grounded IBayesNet.
factory	The factory used to build the grounded IBayesNet.

Definition at line 139 of file PRMSystem_tpl.h.

                                                                                                  {
      factory.startVariableDeclaration();
      factory.variableName(name);

      const DiscreteVariable& agg_var = elt.type().variable();

      VarType var_type = agg_var.varType();

      factory.variableType(var_type);

      switch (var_type) {
        case VarType::Labelized: {
          const auto l = static_cast< const LabelizedVariable& >(agg_var);
          for (Idx i = 0; i < l.domainSize(); ++i) {
            factory.addModality(l.label(i));
          }
          break;
        }
        case VarType::Integer: {
          const auto l = static_cast< const IntegerVariable& >(agg_var);
          for (Idx i = 0; i < l.domainSize(); ++i) {
            factory.addModality(l.label(i));
          }
          break;
        }
        case VarType::Discretized: {
          const auto d = static_cast< const DiscretizedVariable< GUM_SCALAR >& >(agg_var);
          for (Idx i = 0; i < d.domainSize(); ++i) {
            factory.addTick(d.tick(i));
          }
          break;
        }
        case VarType::Range: {
          const auto r = static_cast< const RangeVariable& >(agg_var);
          factory.addMin(r.minVal());
          factory.addMax(r.maxVal());
          break;
        }
        default:
          GUM_ERROR(NotImplementedYet,
                    "PRM aggregator grounding does not support yet such variables");
          break;
      }

      const PRMAggregate< GUM_SCALAR >& agg = static_cast< const PRMAggregate< GUM_SCALAR >& >(elt);

      switch (agg.agg_type()) {
        case PRMAggregate< GUM_SCALAR >::AggregateType::MIN: {
          factory.setVariableCPTImplementation(new aggregator::Min< GUM_SCALAR >());
          break;
        }

        case PRMAggregate< GUM_SCALAR >::AggregateType::MAX: {
          factory.setVariableCPTImplementation(new aggregator::Max< GUM_SCALAR >());
          break;
        }

        case PRMAggregate< GUM_SCALAR >::AggregateType::EXISTS: {
          factory.setVariableCPTImplementation(new aggregator::Exists< GUM_SCALAR >(agg.label()));
          break;
        }

        case PRMAggregate< GUM_SCALAR >::AggregateType::FORALL: {
          factory.setVariableCPTImplementation(new aggregator::Forall< GUM_SCALAR >(agg.label()));
          break;
        }

        case PRMAggregate< GUM_SCALAR >::AggregateType::COUNT: {
          factory.setVariableCPTImplementation(new aggregator::Count< GUM_SCALAR >(agg.label()));
          break;
        }

        case PRMAggregate< GUM_SCALAR >::AggregateType::MEDIAN: {
          factory.setVariableCPTImplementation(new aggregator::Median< GUM_SCALAR >());
          break;
        }

        case PRMAggregate< GUM_SCALAR >::AggregateType::AMPLITUDE: {
          factory.setVariableCPTImplementation(new aggregator::Amplitude< GUM_SCALAR >());
          break;
        }

        case PRMAggregate< GUM_SCALAR >::AggregateType::OR: {
          factory.setVariableCPTImplementation(new aggregator::Or< GUM_SCALAR >());
          break;
        }

        case PRMAggregate< GUM_SCALAR >::AggregateType::AND: {
          factory.setVariableCPTImplementation(new aggregator::And< GUM_SCALAR >());
          break;
        }

        case PRMAggregate< GUM_SCALAR >::AggregateType::SUM: {
          factory.setVariableCPTImplementation(new aggregator::Sum< GUM_SCALAR >());
          break;
        }

        default:
          GUM_ERROR(OperationNotAllowed, "Aggregator not handled yet for " << agg.name())
      }

      factory.endVariableDeclaration();
    }

_groundAttr_()

template<typename GUM_SCALAR>

void gum::prm::PRMSystem< GUM_SCALAR >::_groundAttr_ ( const PRMInstance< GUM_SCALAR > &  instance, BayesNetFactory< GUM_SCALAR > &  factory  ) const

protected

Method which ground Atttributes and Aggregators of an PRMInstance.

Parameters

instance	The PRMInstance grounded by this method.
factory	The factory used to build the grounded IBayesNet.

Definition at line 105 of file PRMSystem_tpl.h.

                                                                                               {
      for (const auto node: instance.type().containerDag()) {
        // Working a Class<GUM_SCALAR> level because PRMAggregate<GUM_SCALAR>
        // are
        // instantiated as PRMAttribute<GUM_SCALAR> in an
        // PRMInstance<GUM_SCALAR>
        switch (instance.type().get(node).elt_type()) {
          case PRMClassElement< GUM_SCALAR >::prm_attribute: {
            // TODO: make a special case for noisy-or
            std::stringstream elt_name;
            elt_name << instance.name() << "." << instance.type().get(node).safeName();
            DiscreteVariable* var = instance.get(node).type().variable().clone();
            var->setName(elt_name.str());
            factory.setVariable(*var);   // var is copied by the factory
            delete var;
            break;
          }

          case PRMClassElement< GUM_SCALAR >::prm_aggregate: {
            std::stringstream elt_name;
            elt_name << instance.name() << "." << instance.type().get(node).safeName();
            _groundAgg_(instance.type().get(node), elt_name.str(), factory);
            break;
          }

          default:
            break;
            /* Do nothing */;
        }
      }
    }

_groundPotential_()

template<typename GUM_SCALAR>

void gum::prm::PRMSystem< GUM_SCALAR >::_groundPotential_ ( const PRMInstance< GUM_SCALAR > &  instance, const PRMAttribute< GUM_SCALAR > &  attr, BayesNetFactory< GUM_SCALAR > &  factory  ) const

protected

Method which copy node's Potential of an PRMInstance to the grounded Bayesian network.

Parameters

instance	The PRMInstance currently grounded.
attr	The PRMAttribute<GUM_SCALAR> for which the Potential is grounded.
factory	The factory used to build the grounded IBayesNet.

Definition at line 299 of file PRMSystem_tpl.h.

                                                                                                  {
      Bijection< const DiscreteVariable*, const DiscreteVariable* > bijection;
      std::stringstream                                             var_name;
      var_name << instance.name() << "." << attr.safeName();
      bijection.insert(&(attr.type().variable()), &(factory.variable(var_name.str())));

      for (const auto parent: instance.type().containerDag().parents(attr.id())) {
        switch (instance.type().get(parent).elt_type()) {
          case PRMClassElement< GUM_SCALAR >::prm_aggregate:
          case PRMClassElement< GUM_SCALAR >::prm_attribute: {
            std::stringstream parent_name;
            parent_name << instance.name() << "." << instance.get(parent).safeName();
            bijection.insert(&(instance.get(parent).type().variable()),
                             &(factory.variable(parent_name.str())));
            break;
          }

          case PRMClassElement< GUM_SCALAR >::prm_slotchain: {
            std::stringstream                 parent_name;
            const PRMSlotChain< GUM_SCALAR >& sc
               = static_cast< const PRMSlotChain< GUM_SCALAR >& >(instance.type().get(parent));
            parent_name << instance.getInstance(sc.id()).name() << "." << sc.lastElt().safeName();
            bijection.insert(
               &(instance.getInstance(sc.id()).get(sc.lastElt().safeName()).type().variable()),
               &(factory.variable(parent_name.str())));
            break;
          }

          default: {
            GUM_ERROR(FatalError, "invalid ClassElement<GUM_SCALAR> type as parent.")
            break;
          }
        }
      }

      // Copy Potential
      // DO NOT USE MultiDimBijArray as they will wreck havok if you delete
      // the prm befor its grounded BN (happens a lot in pyAgrum)
      Potential< GUM_SCALAR >* p = new Potential< GUM_SCALAR >();
      for (auto var: attr.cpf().variablesSequence()) {
        p->add(*(bijection.second(var)));
      }
      Instantiation inst(attr.cpf()), jnst(*p);
      for (inst.setFirst(), jnst.setFirst(); !(inst.end() || jnst.end()); inst.inc(), jnst.inc()) {
        p->set(jnst, attr.cpf().get(inst));
      }
      GUM_ASSERT(inst.end() && jnst.end());
      factory.setVariableCPT(var_name.str(), p, false);
    }

_groundRef_()

template<typename GUM_SCALAR>

void gum::prm::PRMSystem< GUM_SCALAR >::_groundRef_ ( const PRMInstance< GUM_SCALAR > &  instance, BayesNetFactory< GUM_SCALAR > &  factory  ) const

protected

Method which ground PRMReferenceSlot of an PRMInstance and add arcs in the IBayesNet.

Parameters

instance	The PRMInstance grounded by this method.
factory	The factory used to build the grounded IBayesNet.

Definition at line 246 of file PRMSystem_tpl.h.

                                                                                              {
      for (const auto& elt: instance) {
        std::stringstream elt_name;
        elt_name << instance.name() << "." << elt.second->safeName();
        factory.startParentsDeclaration(elt_name.str());

        for (const auto par: instance.type().containerDag().parents(elt.second->id())) {
          switch (instance.type().get(par).elt_type()) {
            case PRMClassElement< GUM_SCALAR >::prm_aggregate:
            case PRMClassElement< GUM_SCALAR >::prm_attribute: {
              std::stringstream parent_name;
              parent_name << instance.name() << "." << instance.get(par).safeName();
              factory.addParent(parent_name.str());
              break;
            }

            case PRMClassElement< GUM_SCALAR >::prm_slotchain: {
              std::string parent_name
                 = static_cast< const PRMSlotChain< GUM_SCALAR >& >(instance.type().get(par))
                      .lastElt()
                      .safeName();

              try {
                for (const auto ref: instance.getInstances(par)) {
                  std::stringstream sBuff;
                  sBuff << ref->name() << "." << parent_name;
                  factory.addParent(sBuff.str());
                }
              } catch (NotFound&) {
                // No instances for this slotchain
              }

              break;
            }

            default:
              break;
              /* nothing to do by default */
          }
        }

        factory.endParentsDeclaration();

        // Checking if we need to ground the Potential (only for class level
        // attributes since
        // aggregates Potentials are generated)
        if (PRMClassElement< GUM_SCALAR >::isAttribute(instance.type().get(elt.second->safeName())))
          _groundPotential_(instance, *elt.second, factory);
      }
    }

add() [1/3]

template<typename GUM_SCALAR>

NodeId gum::prm::PRMSystem< GUM_SCALAR >::add

(

PRMInstance< GUM_SCALAR > *

i

)

Add an PRMInstance to this system.

Exceptions

DuplicateElement

Raised if an PRMInstance with the same name already exists.

Definition at line 67 of file PRMSystem_tpl.h.

                                                                    {
      if (nameMap_.exists(i->name())) {
        GUM_ERROR(DuplicateElement,
                  "an Instance<GUM_SCALAR> with the same is already in this System");
      }

      NodeId id = skeleton_.addNode();
      nodeIdMap_.insert(id, i);
      nameMap_.insert(i->name(), i);

      try {
        instanceMap_[&(i->type())]->insert(i);
      } catch (NotFound&) {
        instanceMap_.insert(&(i->type()), new Set< PRMInstance< GUM_SCALAR >* >());
        instanceMap_[&(i->type())]->insert(i);
      }

      return id;
    }

add() [2/3]

template<typename GUM_SCALAR>

INLINE NodeId gum::prm::PRMSystem< GUM_SCALAR >::add	(	const std::string &	array,
		PRMInstance< GUM_SCALAR > *	i
	)

Add an PRMInstance to an array in this system. If the array doesn't exists it is created.

Exceptions

PRMTypeError	Raised if i is not of the good type.
DuplicateElement	Raised if an PRMInstance with same name already exists.

Definition at line 477 of file PRMSystem_tpl.h.

                                                                             {
      try {
        if (i->type().isSubTypeOf(*(arrayMap_[array].first))) {
          NodeId id = add(i);
          arrayMap_[array].second->insert(i);
          return id;
        } else {
          GUM_ERROR(PRMTypeError,
                    "the given Instance<GUM_SCALAR> is of an incorrect "
                    "Class<GUM_SCALAR> type");
        }
      } catch (NotFound&) { GUM_ERROR(NotFound, "found no array matching the given name") }
    }

add() [3/3]

template<typename GUM_SCALAR>

INLINE NodeId gum::prm::PRMSystem< GUM_SCALAR >::add	(	const std::string &	array,
		PRMInstance< GUM_SCALAR > &	i
	)

Add an PRMInstance to an array in this system. If the array doesn't exists it is created.

Exceptions

PRMTypeError	Raised if i is not of the good type.
DuplicateElement	Raised if an PRMInstance with same name already exists.

Definition at line 352 of file PRMSystem_tpl.h.

                                                                             {
      return add(array, &i);
    }

addArray()

template<typename GUM_SCALAR>

INLINE void gum::prm::PRMSystem< GUM_SCALAR >::addArray	(	const std::string &	array,
		PRMClassElementContainer< GUM_SCALAR > &	type
	)

Add an array of instances in this system. If the array doesn't exists it is created.

Exceptions

DuplicateElement

Raised if an existing array with the same name already exists.

Definition at line 493 of file PRMSystem_tpl.h.

                                                                                                {
      if (arrayMap_.exists(array)) {
        GUM_ERROR(DuplicateElement, "an array '" << array << "' is already in this System")
      }

      arrayMap_.insert(
         array,
         PRMSystem< GUM_SCALAR >::model_pair(&type, new Sequence< PRMInstance< GUM_SCALAR >* >()));
    }

begin() [1/4]

template<typename GUM_SCALAR >

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

(

)

Returns an iterator over the instances in this system.

Definition at line 505 of file PRMSystem_tpl.h.

                                                                                   {
      return nodeIdMap_.begin();
    }

begin() [2/4]

template<typename GUM_SCALAR >

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

(

)

const

Returns a constant iterator over the instances in this system.

Definition at line 515 of file PRMSystem_tpl.h.

                                                                                               {
      return nodeIdMap_.begin();
    }

begin() [3/4]

template<typename GUM_SCALAR >

INLINE PRMSystem< GUM_SCALAR >::array_iterator gum::prm::PRMSystem< GUM_SCALAR >::begin

(

const std::string &

a

)

Returns an iterator at the beginning of the Sequence of PRMInstance in the array named a;.

Exceptions

NotFound

Raised if no array matches a.

Definition at line 527 of file PRMSystem_tpl.h.

                                                        {
      try {
        return arrayMap_[a].second->begin();
      } catch (NotFound&) { GUM_ERROR(NotFound, "found no array matching the given name") }
    }

begin() [4/4]

template<typename GUM_SCALAR >

INLINE PRMSystem< GUM_SCALAR >::const_array_iterator gum::prm::PRMSystem< GUM_SCALAR >::begin

(

const std::string &

a

)

const

Returns an iterator at the beginning of the Sequence of PRMInstance in the array named a;.

Exceptions

NotFound

Raised if no array matches a.

Definition at line 543 of file PRMSystem_tpl.h.

                                                              {
      try {
        return arrayMap_[a].second->begin();
      } catch (NotFound&) { GUM_ERROR(NotFound, "found no array matching the given name") }
    }

end() [1/4]

template<typename GUM_SCALAR >

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

(

)

Returns a iterator at the end of the set of PRMInstance in this PRMSystem.

Definition at line 510 of file PRMSystem_tpl.h.

                                                                                        {
      return nodeIdMap_.end();
    }

end() [2/4]

template<typename GUM_SCALAR >

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

(

)

const

Returns a constant iterator at the end of the set of PRMInstance in this PRMSystem.

Definition at line 521 of file PRMSystem_tpl.h.

                                          {
      return nodeIdMap_.end();
    }

end() [3/4]

template<typename GUM_SCALAR >

INLINE const PRMSystem< GUM_SCALAR >::array_iterator & gum::prm::PRMSystem< GUM_SCALAR >::end

(

const std::string &

a

)

Returns an iterator at the end of the Sequence of PRMInstance in the array named a.

Exceptions

NotFound

Raised if no array matches a.

Definition at line 535 of file PRMSystem_tpl.h.

                                                      {
      try {
        return arrayMap_[a].second->end();
      } catch (NotFound&) { GUM_ERROR(NotFound, "found no array matching the given name") }
    }

end() [4/4]

template<typename GUM_SCALAR >

INLINE const PRMSystem< GUM_SCALAR >::const_array_iterator & gum::prm::PRMSystem< GUM_SCALAR >::end

(

const std::string &

a

)

const

Returns an iterator at the end of the Sequence of PRMInstance in the array named a.

Exceptions

NotFound

Raised if no array matches a.

Definition at line 551 of file PRMSystem_tpl.h.

                                                            {
      try {
        return arrayMap_[a].second->end();
      } catch (NotFound&) { GUM_ERROR(NotFound, "found no array matching the given name") }
    }

enum2str()

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

inlinestaticinherited

Returns the string representation of a PRMObject.

Definition at line 83 of file PRMObject.h.

                                               {
        switch (type) {
          case prm_type::CLASS:
            return "PRMType::CLASS";

          case prm_type::CLASS_ELT:
            return "PRMType::CLASS_ELT";

          case prm_type::TYPE:
            return "PRMType::TYPE";

          case prm_type::SYSTEM:
            return "PRMType::SYSTEM";

          case prm_type::INSTANCE:
            return "PRMType::INSTANCE";

          case prm_type::PRM_INTERFACE:
            return "PRMType::PRM_INTERFACE";

          default:
            return "unknown";
        }
      }

exists()

template<typename GUM_SCALAR >

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

(

const std::string &

name

)

const

Retruns true either if name is an instance or an array in this PRMSystem.

Definition at line 558 of file PRMSystem_tpl.h.

                                                                           {
      return nameMap_.exists(name) || arrayMap_.exists(name);
    }

get() [1/6]

template<typename GUM_SCALAR >

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

(

NodeId

id

)

Returns an PRMInstance given it's NodeId in the relational skeleton.

Exceptions

NotFound

Raised if no PRMInstance matches the given NodeId.

Definition at line 363 of file PRMSystem_tpl.h.

                                                                            {
      try {
        return *(nodeIdMap_[id]);
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "found no Instance<GUM_SCALAR> matching the given id")
      }
    }

get() [2/6]

template<typename GUM_SCALAR >

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

(

NodeId

id

)

const

Returns an PRMInstance given it's NodeId in the relational skeleton.

Exceptions

NotFound

Raised if no PRMInstance matches the given NodeId.

Definition at line 372 of file PRMSystem_tpl.h.

                                                                                        {
      try {
        return *(nodeIdMap_[id]);
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "found no Instance<GUM_SCALAR> matching the given id")
      }
    }

get() [3/6]

template<typename GUM_SCALAR>

INLINE NodeId gum::prm::PRMSystem< GUM_SCALAR >::get

(

const PRMInstance< GUM_SCALAR > &

i

)

const

Returns the relation skeleton of this PRMSystem.

Definition at line 381 of file PRMSystem_tpl.h.

                                                                                       {
      try {
        return nodeIdMap_.keyByVal(const_cast< PRMInstance< GUM_SCALAR >* >(&i));
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "found no Instance<GUM_SCALAR> matching the given id")
      }
    }

get() [4/6]

template<typename GUM_SCALAR>

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

(

const std::string &

name

)

Returns a reference over an PRMInstance given it's name.

Exceptions

NotFound

Raised if the no PRMInstance matches name.

Definition at line 422 of file PRMSystem_tpl.h.

                                                                                        {
      try {
        return *(nameMap_[name]);
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "found no Instance<GUM_SCALAR> matching the given name")
      }
    }

get() [5/6]

template<typename GUM_SCALAR>

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

(

const std::string &

name

)

const

Returns a constant reference over an PRMInstance given it's name.

Exceptions

NotFound

Raised if the no PRMInstance matches name.

Definition at line 432 of file PRMSystem_tpl.h.

                                                                         {
      try {
        return *(nameMap_[name]);
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "found no Instance<GUM_SCALAR> matching the given name")
      }
    }

get() [6/6]

template<typename GUM_SCALAR>

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

(

const PRMClass< GUM_SCALAR > &

type

)

const

Returns the sequence of all instances of the given type.

Exceptions

NotFound

Raised if there is instantiation of type.

Definition at line 443 of file PRMSystem_tpl.h.

                                                                            {
      try {
        return *(instanceMap_[const_cast< PRMClass< GUM_SCALAR >* >(&type)]);
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "the given Class<GUM_SCALAR> has no instantiation in this System");
      }
    }

getArray()

template<typename GUM_SCALAR >

INLINE const Sequence< PRMInstance< GUM_SCALAR > *> & gum::prm::PRMSystem< GUM_SCALAR >::getArray

(

const std::string &

name

)

const

Returns the sequence of instances of a given array.

Exceptions

NotFound

Raised if no array matches name.

Definition at line 454 of file PRMSystem_tpl.h.

                                                                    {
      try {
        return *(arrayMap_[name].second);
      } catch (NotFound&) { GUM_ERROR(NotFound, "found no array matching the given name") }
    }

getArrayType() [1/2]

template<typename GUM_SCALAR >

INLINE PRMClassElementContainer< GUM_SCALAR > & gum::prm::PRMSystem< GUM_SCALAR >::getArrayType

(

const std::string &

name

)

Returns the type of the given array.

Exceptions

NotFound

Raised if no array matches name.

Definition at line 462 of file PRMSystem_tpl.h.

                                                                      {
      try {
        return *(arrayMap_[name].first);
      } catch (NotFound&) { GUM_ERROR(NotFound, "found no array matching the given name") }
    }

getArrayType() [2/2]

template<typename GUM_SCALAR >

INLINE const PRMClassElementContainer< GUM_SCALAR > & gum::prm::PRMSystem< GUM_SCALAR >::getArrayType

(

const std::string &

name

)

const

Returns the type of the given array.

Exceptions

NotFound

Raised if no array matches name.

Definition at line 470 of file PRMSystem_tpl.h.

                                                                                  {
      try {
        return *(arrayMap_[name].first);
      } catch (NotFound&) { GUM_ERROR(NotFound, "found no array matching the given name") }
    }

groundedBN()

template<typename GUM_SCALAR>

void gum::prm::PRMSystem< GUM_SCALAR >::groundedBN

(

BayesNetFactory< GUM_SCALAR > &

factory

)

const

Returns the grounded Bayesian network of this system.

Parameters

factory

The factory used to build the grounded Bayesian network.

Definition at line 88 of file PRMSystem_tpl.h.

                                                                                         {
      factory.startNetworkDeclaration();
      factory.addNetworkProperty("name", name());
      factory.endNetworkDeclaration();

      // Adding nodes
      for (PRMSystem< GUM_SCALAR >::const_iterator iter = begin(); iter != end(); ++iter) {
        _groundAttr_(*(iter.val()), factory);
      }

      // Adding arcs and filling CPTs
      for (PRMSystem< GUM_SCALAR >::const_iterator iter = begin(); iter != end(); ++iter) {
        _groundRef_(*(iter.val()), factory);
      }
    }

instantiate()

template<typename GUM_SCALAR >

INLINE void gum::prm::PRMSystem< GUM_SCALAR >::instantiate

(

)

Instantiate all the PRMInstance in this PRMSystem.

Definition at line 415 of file PRMSystem_tpl.h.

                                                     {
      for (auto iter = begin(); iter != end(); ++iter) {
        (*(iter.val())).instantiate();
      }
    }

isArray()

template<typename GUM_SCALAR >

INLINE bool gum::prm::PRMSystem< GUM_SCALAR >::isArray

(

const std::string &

name

)

const

Returns true if an array with the given name exists.

Definition at line 410 of file PRMSystem_tpl.h.

                                                                            {
      return arrayMap_.exists(name);
    }

isClass()

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

inlinestaticinherited

Returns true if obj_ptr is of type Class.

Definition at line 109 of file PRMObject.h.

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

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

Here is the call graph for this function:

isInstance() [1/2]

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

inlinestaticinherited

Returns true if obj_ptr is of type PRMInstance.

Definition at line 117 of file PRMObject.h.

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

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

Here is the call graph for this function:

isInstance() [2/2]

template<typename GUM_SCALAR >

INLINE bool gum::prm::PRMSystem< GUM_SCALAR >::isInstance

(

const std::string &

name

)

const

Returns true if an PRMInstance with the given name exists.

Definition at line 405 of file PRMSystem_tpl.h.

                                                                               {
      return nameMap_.exists(name);
    }

isInstantiated()

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMSystem< GUM_SCALAR >::isInstantiated

(

const PRMClass< GUM_SCALAR > &

c

)

const

Returns true if the given Class<GUM_SCALAR> has at least one PRMInstance in this PRMSystem.

Definition at line 400 of file PRMSystem_tpl.h.

                                                                                             {
      return instanceMap_.exists(const_cast< PRMClass< GUM_SCALAR >* >(&c));
    }

isInterface()

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

inlinestaticinherited

Returns true if obj_ptr is of type PRMInterface.

Definition at line 112 of file PRMObject.h.

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

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

Here is the call graph for this function:

LEFT_CAST()

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

inlinestaticinherited

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

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

Definition at line 79 of file PRMObject.h.

{ return "("; }

name() [1/2]

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

inherited

Returns the name of this object.

Definition at line 34 of file PRMObject_inl.h.

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

{ return _name_; }

Here is the call graph for this function:

name() [2/2]

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

inherited

Change the name of the PRM Object.

Warning

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

Definition at line 38 of file PRMObject_inl.h.

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

{ _name_ = name; }

Here is the call graph for this function:

obj_type()

template<typename GUM_SCALAR >

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

virtual

Returns the PRM type of this object.

Implements gum::prm::PRMObject.

Definition at line 390 of file PRMSystem_tpl.h.

                                                                     {
      return PRMObject::prm_type::SYSTEM;
    }

operator!=()

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

inherited

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

Definition at line 46 of file PRMObject_inl.h.

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

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

Here is the call graph for this function:

operator=()

template<typename GUM_SCALAR>

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

protecteddelete

Copy operator. Don't use it.

operator==()

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

inherited

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

Definition at line 42 of file PRMObject_inl.h.

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

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

Here is the call graph for this function:

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

size()

template<typename GUM_SCALAR >

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

(

)

const

Returns the number of PRMInstance in this PRMSystem.

Definition at line 395 of file PRMSystem_tpl.h.

                                                    {
      return nodeIdMap_.size();
    }

skeleton()

template<typename GUM_SCALAR >

INLINE const DiGraph & gum::prm::PRMSystem< GUM_SCALAR >::skeleton

(

)

const

Returns the relation skeleton of this PRMSystem.

Definition at line 358 of file PRMSystem_tpl.h.

                                                                  {
      return skeleton_;
    }

Member Data Documentation

arrayMap_

template<typename GUM_SCALAR>

HashTable< std::string, model_pair > gum::prm::PRMSystem< GUM_SCALAR >::arrayMap_

protected

Mapping between arrays and their name. The first element of the pair is the type of the array.

Definition at line 283 of file PRMSystem.h.

instanceMap_

template<typename GUM_SCALAR>

HashTable< PRMClass< GUM_SCALAR >*, Set< PRMInstance< GUM_SCALAR >* >* > gum::prm::PRMSystem< GUM_SCALAR >::instanceMap_

protected

Mapping between a class and all it's PRMInstance in this system.

Definition at line 273 of file PRMSystem.h.

nameMap_

template<typename GUM_SCALAR>

HashTable< std::string, PRMInstance< GUM_SCALAR >* > gum::prm::PRMSystem< GUM_SCALAR >::nameMap_

protected

The mapping between PRMInstance and their names.

Definition at line 270 of file PRMSystem.h.

nodeIdMap_

template<typename GUM_SCALAR>

NodeProperty< PRMInstance< GUM_SCALAR >* > gum::prm::PRMSystem< GUM_SCALAR >::nodeIdMap_

protected

The mapping between PRMInstance and their NodeId in the relational skeleton of this PRMSystem.

Definition at line 267 of file PRMSystem.h.

skeleton_

template<typename GUM_SCALAR>

DiGraph gum::prm::PRMSystem< GUM_SCALAR >::skeleton_

protected

The relational skeleton of this PRMSystem.

Definition at line 263 of file PRMSystem.h.

---

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

• agrum/PRM/elements/PRMObject.h
• agrum/PRM/elements/PRMSystem.h
• agrum/PRM/elements/PRMSystem_tpl.h