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

This class represent the dependencies of all classes in a PRM<GUM_SCALAR>. More...

#include <agrum/PRM/classDependencyGraph.h>

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

Public Member Functions
Constructors and Destructor.
	ClassDependencyGraph (const PRM< GUM_SCALAR > &prm)
	Default constructor. More...
	ClassDependencyGraph (const ClassDependencyGraph< GUM_SCALAR > &source)
	Copy constructor. More...
	~ClassDependencyGraph ()
	Destructor. More...
Getters & setters.
const DAG &	dag () const
	Returns a constant reference over the graph of the DAG representing the ClassDependencyGraph<GUM_SCALAR>. More...
const EltPair &	get (NodeId id) const
	Returns a constant reference over the element assiociated with the node id in the ClassDependencyGraph<GUM_SCALAR>. More...
NodeId	get (const PRMClassElementContainer< GUM_SCALAR > &c, const PRMClassElement< GUM_SCALAR > &elt) const
	Returns the NodeId assign to the given PRMClassElement<GUM_SCALAR> of a given Class. Is is necessary to give both Class and PRMClassElement<GUM_SCALAR> because inherited PRMClassElement<GUM_SCALAR> are shared in the inheritance hierarchy. More...
const NodeProperty< Size > &	modalities () const
	Returns a mapping between the ClassDependencyGraph<GUM_SCALAR>'s nodes and their modalities. More...

Public Types
typedef std::pair< const PRMClassElementContainer< GUM_SCALAR > *, const PRMClassElement< GUM_SCALAR > *>	EltPair
	Association between a class element and it's holding class. More...

Detailed Description

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

This class represent the dependencies of all classes in a PRM<GUM_SCALAR>.

A Class Dependency Graph does listen to changes in it's PRM<GUM_SCALAR>.

Definition at line 46 of file classDependencyGraph.h.

Member Typedef Documentation

EltPair

template<typename GUM_SCALAR >

typedef std::pair< const PRMClassElementContainer< GUM_SCALAR >*, const PRMClassElement< GUM_SCALAR >* > gum::prm::ClassDependencyGraph< GUM_SCALAR >::EltPair

Association between a class element and it's holding class.

Definition at line 51 of file classDependencyGraph.h.

NodeMap

template<typename GUM_SCALAR >

typedef HashTable< const PRMClassElementContainer< GUM_SCALAR >*, HashTable< const PRMClassElement< GUM_SCALAR >*, NodeId >* > gum::prm::ClassDependencyGraph< GUM_SCALAR >::NodeMap

private

Code shortcut.

Definition at line 136 of file classDependencyGraph.h.

Constructor & Destructor Documentation

ClassDependencyGraph() [1/2]

template<typename GUM_SCALAR >

INLINE gum::prm::ClassDependencyGraph< GUM_SCALAR >::ClassDependencyGraph

(

const PRM< GUM_SCALAR > &

prm

)

Default constructor.

Parameters

prm	The PRM<GUM_SCALAR> for which this ClassDependencyGraph<GUM_SCALAR> is constructed.

Definition at line 103 of file classDependencyGraph_tpl.h.

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

                                                                                                {
      GUM_CONSTRUCTOR(ClassDependencyGraph);
      _buildGraph_(prm);
    }

Here is the call graph for this function:

ClassDependencyGraph() [2/2]

template<typename GUM_SCALAR >

INLINE gum::prm::ClassDependencyGraph< GUM_SCALAR >::ClassDependencyGraph

(

const ClassDependencyGraph< GUM_SCALAR > &

source

)

Copy constructor.

Definition at line 109 of file classDependencyGraph_tpl.h.

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

                                                         :
        _graph_(source._graph_),
        _modalitites_(source._modalitites_), _elt_map_(source._elt_map_) {
      GUM_CONS_CPY(ClassDependencyGraph);

      for (const auto elt: source._node_map_) {
        _node_map_.insert(
           elt.first,
           new HashTable< const PRMClassElement< GUM_SCALAR >*, NodeId >(*elt.second));
      }
    }

Here is the call graph for this function:

~ClassDependencyGraph()

template<typename GUM_SCALAR >

gum::prm::ClassDependencyGraph< GUM_SCALAR >::~ClassDependencyGraph

(

)

Destructor.

Definition at line 35 of file classDependencyGraph_tpl.h.

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

                                                              {
      GUM_DESTRUCTOR(ClassDependencyGraph);

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

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

Here is the call graph for this function:

Member Function Documentation

_addArcs_()

template<typename GUM_SCALAR >

void gum::prm::ClassDependencyGraph< GUM_SCALAR >::_addArcs_ ( const PRMClassElementContainer< GUM_SCALAR > &  c, NodeId  node, HashTable< const PRMClassElement< GUM_SCALAR > *, NodeId > &  map  )

private

Add arcs in graph.

Definition at line 72 of file classDependencyGraph_tpl.h.

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

                                                                       {
      switch (c.get(node).elt_type()) {
        case PRMClassElement< GUM_SCALAR >::prm_slotchain: {
          const PRMSlotChain< GUM_SCALAR >& sc
             = static_cast< const PRMSlotChain< GUM_SCALAR >& >(c.get(node));

          for (const auto chi: c.containerDag().children(node))
            _graph_.addArc((*(_node_map_[&(sc.end())]))[&(sc.end().get(sc.lastElt().safeName()))],
                           map[&(c.get(chi))]);

          break;
        }

        case PRMClassElement< GUM_SCALAR >::prm_aggregate:
        case PRMClassElement< GUM_SCALAR >::prm_attribute: {
          for (const auto chi: c.containerDag().children(node))
            _graph_.addArc(map[&(c.get(node))], map[&(c.get(chi))]);

          break;
        }

        default: { /* do nothing */
          break;
        }
      }
    }

Here is the call graph for this function:

_addNode_()

template<typename GUM_SCALAR >

INLINE void gum::prm::ClassDependencyGraph< GUM_SCALAR >::_addNode_ ( const PRMClassElementContainer< GUM_SCALAR > *  c, const PRMClassElement< GUM_SCALAR > &  elt  )

private

Add nodes in graph while updating consequently all the mappings.

Definition at line 146 of file classDependencyGraph_tpl.h.

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

                                                          {
      switch (elt.elt_type()) {
        case PRMClassElement< GUM_SCALAR >::prm_attribute:
        case PRMClassElement< GUM_SCALAR >::prm_aggregate: {
          NodeId id = _graph_.addNode();
          _elt_map_.insert(id, new ClassDependencyGraph< GUM_SCALAR >::EltPair(c, &elt));
          _node_map_[c]->insert(&elt, id);
          _modalitites_.insert(id, elt.type().variable().domainSize());
          break;
        }

        default: { /* do nothing */
          break;
        }
      }
    }

Here is the call graph for this function:

_buildGraph_()

template<typename GUM_SCALAR >

void gum::prm::ClassDependencyGraph< GUM_SCALAR >::_buildGraph_ ( const PRM< GUM_SCALAR > &  prm )

private

Build the class dependency graph.

Definition at line 47 of file classDependencyGraph_tpl.h.

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

                                                                                      {
      // First we add all nodes
      for (const auto ci: prm.classes()) {
        _node_map_.insert(ci, new HashTable< const PRMClassElement< GUM_SCALAR >*, NodeId >());

        for (const auto node: ci->containerDag().nodes())
          _addNode_(ci, ci->get(node));
      }

      for (const auto ii: prm.interfaces()) {
        _node_map_.insert(ii, new HashTable< const PRMClassElement< GUM_SCALAR >*, NodeId >());

        for (const auto node: ii->containerDag().nodes()) {
          _addNode_(ii, ii->get(node));
        }
      }

      // Then we add the arcs
      for (const auto cc: prm.classes())
        for (const auto node: cc->containerDag().nodes())
          _addArcs_(*cc, node, *(_node_map_[cc]));
    }

Here is the call graph for this function:

dag()

template<typename GUM_SCALAR >

INLINE const DAG & gum::prm::ClassDependencyGraph< GUM_SCALAR >::dag

(

)

const

Returns a constant reference over the graph of the DAG representing the ClassDependencyGraph<GUM_SCALAR>.

Definition at line 123 of file classDependencyGraph_tpl.h.

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

                                                                    {
      return _graph_;
    }

Here is the call graph for this function:

get() [1/2]

template<typename GUM_SCALAR >

INLINE const ClassDependencyGraph< GUM_SCALAR >::EltPair & gum::prm::ClassDependencyGraph< GUM_SCALAR >::get

(

NodeId

id

)

const

Returns a constant reference over the element assiociated with the node id in the ClassDependencyGraph<GUM_SCALAR>.

Exceptions

NotFound

Raised if no nodes matches id.

Definition at line 129 of file classDependencyGraph_tpl.h.

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

                                                              {
      return *(_elt_map_[id]);
    }

Here is the call graph for this function:

get() [2/2]

template<typename GUM_SCALAR >

INLINE NodeId gum::prm::ClassDependencyGraph< GUM_SCALAR >::get	(	const PRMClassElementContainer< GUM_SCALAR > &	c,
		const PRMClassElement< GUM_SCALAR > &	elt
	)		const

Returns the NodeId assign to the given PRMClassElement<GUM_SCALAR> of a given Class. Is is necessary to give both Class and PRMClassElement<GUM_SCALAR> because inherited PRMClassElement<GUM_SCALAR> are shared in the inheritance hierarchy.

Definition at line 135 of file classDependencyGraph_tpl.h.

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

                                                                                               {
      return (*(_node_map_[&c]))[&elt];
    }

Here is the call graph for this function:

modalities()

template<typename GUM_SCALAR >

INLINE const NodeProperty< Size > & gum::prm::ClassDependencyGraph< GUM_SCALAR >::modalities

(

)

const

Returns a mapping between the ClassDependencyGraph<GUM_SCALAR>'s nodes and their modalities.

Definition at line 141 of file classDependencyGraph_tpl.h.

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

                                                                                            {
      return _modalitites_;
    }

Here is the call graph for this function:

Member Data Documentation

_elt_map_

template<typename GUM_SCALAR >

NodeProperty< EltPair* > gum::prm::ClassDependencyGraph< GUM_SCALAR >::_elt_map_

private

Mapping between the nodes in graph with the PRMClassElement<GUM_SCALAR> in the PRM<GUM_SCALAR>.

Definition at line 131 of file classDependencyGraph.h.

_graph_

template<typename GUM_SCALAR >

DAG gum::prm::ClassDependencyGraph< GUM_SCALAR >::_graph_

private

The graph itself.

Definition at line 117 of file classDependencyGraph.h.

_modalitites_

template<typename GUM_SCALAR >

NodeProperty< Size > gum::prm::ClassDependencyGraph< GUM_SCALAR >::_modalitites_

private

The modalities map for each node in the ClassDependencyGraph<GUM_SCALAR>. This is useful when using a Triangulation class over a ClassDependencyGraph<GUM_SCALAR>.

Definition at line 124 of file classDependencyGraph.h.

_node_map_

template<typename GUM_SCALAR >

NodeMap gum::prm::ClassDependencyGraph< GUM_SCALAR >::_node_map_

private

Map each Class to a HashTable mapping the Class's ClassElements to their assigned NodeId in graph.

Definition at line 141 of file classDependencyGraph.h.

---

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

• agrum/PRM/classDependencyGraph.h
• agrum/PRM/classDependencyGraph_tpl.h