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 47 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 52 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 139 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 107 of file classDependencyGraph_tpl.h.

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

ClassDependencyGraph() [2/2]

template<typename GUM_SCALAR >

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

(

const ClassDependencyGraph< GUM_SCALAR > &

source

)

Copy constructor.

Definition at line 114 of file classDependencyGraph_tpl.h.

References gum::prm::ClassDependencyGraph< GUM_SCALAR >::__node_map, and gum::HashTable< Key, Val, Alloc >::insert().

                                                         :
        __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 36 of file classDependencyGraph_tpl.h.

                                                              {
      GUM_DESTRUCTOR(ClassDependencyGraph);

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

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

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 76 of file classDependencyGraph_tpl.h.

References gum::prm::PRMClassElementContainer< GUM_SCALAR >::containerDag(), gum::prm::PRMSlotChain< GUM_SCALAR >::end(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::get(), and gum::prm::PRMSlotChain< GUM_SCALAR >::lastElt().

                                                                       {
      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 153 of file classDependencyGraph_tpl.h.

References gum::prm::ClassDependencyGraph< GUM_SCALAR >::__elt_map, gum::prm::ClassDependencyGraph< GUM_SCALAR >::__graph, gum::prm::ClassDependencyGraph< GUM_SCALAR >::__modalitites, gum::prm::ClassDependencyGraph< GUM_SCALAR >::__node_map, gum::NodeGraphPart::addNode(), gum::prm::PRMClassElement< GUM_SCALAR >::elt_type(), gum::HashTable< Key, Val, Alloc >::insert(), and gum::prm::PRMClassElement< GUM_SCALAR >::type().

                                                          {
      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 48 of file classDependencyGraph_tpl.h.

References gum::prm::PRM< GUM_SCALAR >::classes(), and gum::prm::PRM< GUM_SCALAR >::interfaces().

                                     {
      // 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 129 of file classDependencyGraph_tpl.h.

References gum::prm::ClassDependencyGraph< GUM_SCALAR >::__graph.

Referenced by gum::prm::SVED< GUM_SCALAR >::__initElimOrder(), and gum::prm::SVE< GUM_SCALAR >::__initElimOrder().

                                                                    {
      return __graph;
    }

Here is the caller 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 135 of file classDependencyGraph_tpl.h.

References gum::prm::ClassDependencyGraph< GUM_SCALAR >::__elt_map.

Referenced by gum::prm::SVED< GUM_SCALAR >::__initElimOrder(), and gum::prm::SVE< GUM_SCALAR >::__initElimOrder().

                                                              {
      return *(__elt_map[id]);
    }

Here is the caller 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 140 of file classDependencyGraph_tpl.h.

References gum::prm::ClassDependencyGraph< GUM_SCALAR >::__node_map.

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

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 148 of file classDependencyGraph_tpl.h.

References gum::prm::ClassDependencyGraph< GUM_SCALAR >::__modalitites.

                                                                      {
      return __modalitites;
    }

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 133 of file classDependencyGraph.h.

Referenced by gum::prm::ClassDependencyGraph< GUM_SCALAR >::__addNode(), and gum::prm::ClassDependencyGraph< GUM_SCALAR >::get().

__graph

template<typename GUM_SCALAR>

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

private

The graph itself.

Definition at line 119 of file classDependencyGraph.h.

Referenced by gum::prm::ClassDependencyGraph< GUM_SCALAR >::__addNode(), and gum::prm::ClassDependencyGraph< GUM_SCALAR >::dag().

__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 126 of file classDependencyGraph.h.

Referenced by gum::prm::ClassDependencyGraph< GUM_SCALAR >::__addNode(), and gum::prm::ClassDependencyGraph< GUM_SCALAR >::modalities().

__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 144 of file classDependencyGraph.h.

Referenced by gum::prm::ClassDependencyGraph< GUM_SCALAR >::__addNode(), gum::prm::ClassDependencyGraph< GUM_SCALAR >::ClassDependencyGraph(), and gum::prm::ClassDependencyGraph< GUM_SCALAR >::get().

---

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

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