gum::prm::gspan::InterfaceGraph< GUM_SCALAR > Class Template Reference

This class represent the interface graph of a given gum::prm::PRMSystem<GUM_SCALAR>. More...

#include <agrum/PRM/gspan/interfaceGraph.h>

Collaboration diagram for gum::prm::gspan::InterfaceGraph< GUM_SCALAR >:

Public Member Functions
	InterfaceGraph (const PRMSystem< GUM_SCALAR > &sys)
	Default constructor. More...
	InterfaceGraph (const InterfaceGraph &source)
	Copy constructor, proceeds with a shallow copy so for friends only. More...
InterfaceGraph &	operator= (const InterfaceGraph &source)
	Copy operator. More...
	~InterfaceGraph ()
	Destructor. More...
UndiGraph &	graph ()
	Returns the graph of this interface graph. More...
const UndiGraph &	graph () const
	Returns the graph of this interface graph. More...
Bijection< Idx, LabelData *> &	labels ()
	Returns the bijection between LabelData and their string representation. More...
const Bijection< Idx, LabelData *> &	labels () const
	Returns the bijection between LabelData and their string representation. More...
Size	size (const LabelData *l) const
	Returns the number of node or edges labelled by l. More...
Set< NodeData< GUM_SCALAR > *> &	nodes (const LabelData *l)
	Returns the set of nodes labelled by l. More...
const Set< NodeData< GUM_SCALAR > *> &	nodes (const LabelData *l) const
	Returns the set of nodes labelled by l. More...
Set< EdgeData< GUM_SCALAR > *> &	edges (const LabelData *l)
	Returns the set of nodes labelled by l. More...
const Set< EdgeData< GUM_SCALAR > *> &	edges (const LabelData *l) const
	Returns the set of nodes labelled by l. More...
LabelData *	label (Idx id)
	Returns a label given its id. More...
NodeId	id (const PRMInstance< GUM_SCALAR > &i) const
	Returns the id of i in this interface graph. More...
NodeId	id (const PRMInstance< GUM_SCALAR > *i) const
	Returns the id of i in this interface graph. More...
NodeData< GUM_SCALAR > &	node (const PRMInstance< GUM_SCALAR > *i)
	Returns data about a node. More...
const NodeData< GUM_SCALAR > &	node (const PRMInstance< GUM_SCALAR > *i) const
	Returns data about a node. More...
NodeData< GUM_SCALAR > &	node (NodeId id)
	Returns data about a node. More...
const NodeData< GUM_SCALAR > &	node (NodeId id) const
	Returns data about a node. More...
EdgeData< GUM_SCALAR > &	edge (NodeId u, NodeId v)
	Returns data about an edge. More...
const EdgeData< GUM_SCALAR > &	edge (NodeId u, NodeId v) const
	Returns data about an edge. More...

Friends
class	gum::prm::GSpan< GUM_SCALAR >

Detailed Description

template<typename GUM_SCALAR>
class gum::prm::gspan::InterfaceGraph< GUM_SCALAR >

This class represent the interface graph of a given gum::prm::PRMSystem<GUM_SCALAR>.

An interface graph is a labelled graph over the instances of a gum::prm::PRMSystem<GUM_SCALAR>, where there exists an edge between two instance i and j if and only if their shared interface is nonempty.

Labels assigned to edges and nodes in the interface graph are technically strings, however since we need a linear oder each label is assigned a unique id.

Definition at line 166 of file interfaceGraph.h.

Constructor & Destructor Documentation

InterfaceGraph() [1/2]

template<typename GUM_SCALAR >

gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::InterfaceGraph ( const PRMSystem< GUM_SCALAR > &  sys )

explicit

Default constructor.

Definition at line 98 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                             :
          sys__(&sys),
          labels__(new Bijection< Idx, LabelData* >()), counter__(0),
          erase_flag__(true) {
        GUM_CONSTRUCTOR(InterfaceGraph);
        HashTable< std::string, LabelData* > label_map;

        // We need to add each instance in graph__
        for (auto iter = sys.begin(); iter != sys.end(); ++iter) {
          NodeData< GUM_SCALAR >* node = new NodeData< GUM_SCALAR >();
          node->n                      = iter.val();
          label__(node, label_map);
          graph__.addNodeWithId(iter.key());
          idMap__.insert(node->n, iter.key());
          nodes__.insert(iter.key(), node);
        }

        NodeData< GUM_SCALAR >* u = nullptr;
        NodeData< GUM_SCALAR >* v = nullptr;

        for (const auto& elt: nodes__) {
          NodeData< GUM_SCALAR >* data = elt.second;

          for (const auto chain: data->n->type().slotChains()) {
            for (const auto inst: data->n->getInstances(chain->id())) {
              u = (nodes__[idMap__[inst]]->l < data->l) ? nodes__[idMap__[inst]]
                                                        : data;
              v = (u != data) ? data : nodes__[idMap__[inst]];

              if (!graph__.existsEdge(idMap__[u->n], idMap__[v->n])) {
                EdgeData< GUM_SCALAR >* edge = new EdgeData< GUM_SCALAR >();
                edge->u                      = u->n;
                edge->l_u                    = u->l;
                edge->v                      = v->n;
                edge->l_v                    = v->l;
                label__(edge, label_map);
                graph__.addEdge(idMap__[u->n], idMap__[v->n]);
                edges__.insert(Edge(idMap__[u->n], idMap__[v->n]), edge);
              }
            }
          }
        }
      }

Here is the call graph for this function:

InterfaceGraph() [2/2]

template<typename GUM_SCALAR >

gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::InterfaceGraph

(

const InterfaceGraph< GUM_SCALAR > &

source

)

Copy constructor, proceeds with a shallow copy so for friends only.

Definition at line 144 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                     :
          sys__(source.sys__),
          graph__(source.graph__), nodes__(source.nodes__),
          idMap__(source.idMap__), edges__(source.edges__),
          labels__(new Bijection< Idx, LabelData* >(*(source.labels__))),
          nodeMap__(source.nodeMap__), edgeMap__(source.edgeMap__),
          counter__(source.counter__), erase_flag__(false) {
        GUM_CONS_CPY(InterfaceGraph);
      }

Here is the call graph for this function:

~InterfaceGraph()

template<typename GUM_SCALAR >

gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::~InterfaceGraph

(

)

Destructor.

Definition at line 156 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                    {
        GUM_DESTRUCTOR(InterfaceGraph);

        if (erase_flag__) {
          for (const auto& elt: nodes__)
            delete elt.second;

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

          for (const auto& elt: nodeMap__) {
            delete elt.first;
            delete elt.second;
          }

          for (const auto& elt: edgeMap__) {
            delete elt.first;
            delete elt.second;
          }
        }

        delete labels__;
      }

Here is the call graph for this function:

Member Function Documentation

edge() [1/2]

template<typename GUM_SCALAR >

INLINE EdgeData< GUM_SCALAR > & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::edge	(	NodeId	u,
		NodeId	v
	)

Returns data about an edge.

Exceptions

NotFound

Definition at line 370 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                                                  {
        try {
          return *(edges__[Edge(u, v)]);
        } catch (NotFound&) { return *(edges__[Edge(v, u)]); }
      }

Here is the call graph for this function:

edge() [2/2]

template<typename GUM_SCALAR >

INLINE const EdgeData< GUM_SCALAR > & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::edge	(	NodeId	u,
		NodeId	v
	)		const

Returns data about an edge.

Exceptions

NotFound

Definition at line 379 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                                              {
        try {
          return *(edges__[Edge(u, v)]);
        } catch (NotFound&) { return *(edges__[Edge(v, u)]); }
      }

Here is the call graph for this function:

edges() [1/2]

template<typename GUM_SCALAR >

INLINE Set< EdgeData< GUM_SCALAR > *> & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::edges

(

const LabelData *

l

)

Returns the set of nodes labelled by l.

Definition at line 318 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                                   {
        return *(edgeMap__[const_cast< LabelData* >(l)]);
      }

Here is the call graph for this function:

edges() [2/2]

template<typename GUM_SCALAR >

INLINE const Set< EdgeData< GUM_SCALAR > *> & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::edges

(

const LabelData *

l

)

const

Returns the set of nodes labelled by l.

Definition at line 324 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                                               {
        return *(edgeMap__[const_cast< LabelData* >(l)]);
      }

Here is the call graph for this function:

graph() [1/2]

template<typename GUM_SCALAR >

INLINE UndiGraph & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::graph

(

)

Returns the graph of this interface graph.

Definition at line 275 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                            {
        return graph__;
      }

Here is the call graph for this function:

graph() [2/2]

template<typename GUM_SCALAR >

INLINE const UndiGraph & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::graph

(

)

const

Returns the graph of this interface graph.

Definition at line 280 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                                        {
        return graph__;
      }

Here is the call graph for this function:

id() [1/2]

template<typename GUM_SCALAR >

INLINE NodeId gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::id

(

const PRMInstance< GUM_SCALAR > &

i

)

const

Returns the id of i in this interface graph.

Definition at line 334 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                   {
        return idMap__[const_cast< PRMInstance< GUM_SCALAR >* >(&i)];
      }

Here is the call graph for this function:

id() [2/2]

template<typename GUM_SCALAR >

INLINE NodeId gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::id

(

const PRMInstance< GUM_SCALAR > *

i

)

const

Returns the id of i in this interface graph.

Definition at line 340 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                   {
        return idMap__[const_cast< PRMInstance< GUM_SCALAR >* >(i)];
      }

Here is the call graph for this function:

label()

template<typename GUM_SCALAR >

INLINE LabelData * gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::label

(

Idx

id

)

Returns a label given its id.

Definition at line 329 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                                  {
        return labels__->second(id);
      }

Here is the call graph for this function:

label__() [1/2]

template<typename GUM_SCALAR >

void gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::label__ ( NodeData< GUM_SCALAR > *  node, HashTable< std::string, LabelData * > &  label_map  )

private

Compute the label of node and add it to labels__ if it does not exists yet. Update node with the correct label's id.

Definition at line 187 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                        {
        Size              size = Size(1);
        std::stringstream sBuff;
        sBuff << node->n->type().name();

        // First we search for multiple inputs
        for (const auto chain: node->n->type().slotChains()) {
          if (chain->isMultiple()) {
            sBuff << "-" << node->n->getInstances(chain->id()).size();
            sBuff << chain->name();
            size *= node->n->getInstances(chain->id()).size()
                  * chain->lastElt().type().variable().domainSize();
          } else {
            size *= chain->lastElt().type().variable().domainSize();
          }
        }

        // Second we search for active outputs
        for (const auto nn: node->n->type().containerDag().nodes()) {
          if (node->n->type().isOutputNode(node->n->type().get(nn))) {
            try {
              sBuff << "-" << node->n->getRefAttr(nn).size()
                    << node->n->get(nn).name();
              size *= node->n->get(nn).type().variable().domainSize();
            } catch (NotFound&) {
              // (nn) is an inactive output node
            }
          }
        }

        // Label is ready
        if (!label_map.exists(sBuff.str())) {
          LabelData* label = new LabelData();
          label_map.insert(sBuff.str(), label);
          label->id         = ++counter__;
          label->tree_width = size;
          label->l          = sBuff.str();
          labels__->insert(label->id, label);
          nodeMap__.insert(label, new Set< NodeData< GUM_SCALAR >* >());
        }

        node->l = label_map[sBuff.str()];
        nodeMap__[node->l]->insert(node);
      }

Here is the call graph for this function:

label__() [2/2]

template<typename GUM_SCALAR >

void gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::label__ ( EdgeData< GUM_SCALAR > *  edge, HashTable< std::string, LabelData * > &  label_map  )

private

Compute the label of edge and add it to labels__ if it does not exists yet. Update edge with the correct label's id.

Definition at line 235 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                        {
        Size              size = Size(1);
        std::stringstream sBuff;
        sBuff << edge->u->type().name() << "-" << edge->v->type().name();

        // First looking for edge->u output nodes in v
        for (const auto chain: edge->u->type().slotChains()) {
          if (edge->u->getInstances(chain->id()).exists(edge->v)) {
            sBuff << "-" << edge->v->type().name() << "."
                  << chain->lastElt().name();
            size *= chain->lastElt().type().variable().domainSize();
          }
        }

        // Second looking for edge->v output nodes in u
        for (const auto chain: edge->v->type().slotChains())
          if (edge->v->getInstances(chain->id()).exists(edge->u)) {
            sBuff << "-" << edge->u->type().name() << "."
                  << chain->lastElt().name();
            size *= chain->lastElt().type().variable().domainSize();
          }

        // Label is ready
        if (!label_map.exists(sBuff.str())) {
          LabelData* label = new LabelData();
          label_map.insert(sBuff.str(), label);
          label->id         = ++counter__;
          label->l          = sBuff.str();
          label->tree_width = size;
          labels__->insert(label->id, label);
          edgeMap__.insert(label, new Set< EdgeData< GUM_SCALAR >* >());
        }

        edge->l = label_map[sBuff.str()];
        edgeMap__[edge->l]->insert(edge);
      }

Here is the call graph for this function:

labels() [1/2]

template<typename GUM_SCALAR >

INLINE Bijection< Idx, LabelData *> & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::labels

(

)

Returns the bijection between LabelData and their string representation.

Definition at line 285 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                                                {
        return *labels__;
      }

Here is the call graph for this function:

labels() [2/2]

template<typename GUM_SCALAR >

INLINE const Bijection< Idx, LabelData *> & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::labels

(

)

const

Returns the bijection between LabelData and their string representation.

Definition at line 291 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                              {
        return *labels__;
      }

Here is the call graph for this function:

node() [1/4]

template<typename GUM_SCALAR >

INLINE NodeData< GUM_SCALAR > & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::node

(

const PRMInstance< GUM_SCALAR > *

i

)

Returns data about a node.

Exceptions

NotFound

Definition at line 347 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                                              {
        return node(id(i));
      }

Here is the call graph for this function:

node() [2/4]

template<typename GUM_SCALAR >

INLINE const NodeData< GUM_SCALAR > & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::node

(

const PRMInstance< GUM_SCALAR > *

i

)

const

Returns data about a node.

Exceptions

NotFound

Definition at line 352 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                   {
        return node(id(i));
      }

Here is the call graph for this function:

node() [3/4]

template<typename GUM_SCALAR >

INLINE NodeData< GUM_SCALAR > & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::node

(

NodeId

id

)

Returns data about a node.

Exceptions

NotFound

Definition at line 359 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                         {
        return *(nodes__[id]);
      }

Here is the call graph for this function:

node() [4/4]

template<typename GUM_SCALAR >

INLINE const NodeData< GUM_SCALAR > & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::node

(

NodeId

id

)

const

Returns data about a node.

Exceptions

NotFound

Definition at line 365 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                                     {
        return *(nodes__[id]);
      }

Here is the call graph for this function:

nodes() [1/2]

template<typename GUM_SCALAR >

INLINE Set< NodeData< GUM_SCALAR > *> & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::nodes

(

const LabelData *

l

)

Returns the set of nodes labelled by l.

Definition at line 306 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                                   {
        return *(nodeMap__[const_cast< LabelData* >(l)]);
      }

Here is the call graph for this function:

nodes() [2/2]

template<typename GUM_SCALAR >

INLINE const Set< NodeData< GUM_SCALAR > *> & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::nodes

(

const LabelData *

l

)

const

Returns the set of nodes labelled by l.

Definition at line 312 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                                               {
        return *(nodeMap__[const_cast< LabelData* >(l)]);
      }

Here is the call graph for this function:

operator=()

template<typename GUM_SCALAR >

InterfaceGraph< GUM_SCALAR > & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::operator=

(

const InterfaceGraph< GUM_SCALAR > &

source

)

Copy operator.

Definition at line 181 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                     {
        GUM_ERROR(FatalError, "not implemented");
      }

Here is the call graph for this function:

size()

template<typename GUM_SCALAR >

INLINE Size gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::size

(

const LabelData *

l

)

const

Returns the number of node or edges labelled by l.

Definition at line 296 of file interfaceGraph_tpl.h.

References gum::prm::gspan::operator<<().

                                                                             {
        try {
          return nodeMap__[const_cast< LabelData* >(l)]->size();
        } catch (NotFound&) {
          return edgeMap__[const_cast< LabelData* >(l)]->size();
        }
      }

Here is the call graph for this function:

Friends And Related Function Documentation

gum::prm::GSpan< GUM_SCALAR >

template<typename GUM_SCALAR >

friend class gum::prm::GSpan< GUM_SCALAR >

friend

Definition at line 167 of file interfaceGraph.h.

Member Data Documentation

counter__

template<typename GUM_SCALAR >

Idx gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::counter__

private

A counter used of assigning ids to labels.

Definition at line 276 of file interfaceGraph.h.

edgeMap__

template<typename GUM_SCALAR >

HashTable< LabelData*, Set< EdgeData< GUM_SCALAR >* >* > gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::edgeMap__

private

Mapping between a LabelData and the set of EdgeData<GUM_SCALAR> with that label.

Definition at line 273 of file interfaceGraph.h.

edges__

template<typename GUM_SCALAR >

EdgeProperty< EdgeData< GUM_SCALAR >* > gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::edges__

private

Data associated with edges in graph__.

Definition at line 260 of file interfaceGraph.h.

erase_flag__

template<typename GUM_SCALAR >

bool gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::erase_flag__

private

For shallow copies.

Definition at line 279 of file interfaceGraph.h.

graph__

template<typename GUM_SCALAR >

UndiGraph gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::graph__

private

The interface graph.

Definition at line 251 of file interfaceGraph.h.

idMap__

template<typename GUM_SCALAR >

HashTable< PRMInstance< GUM_SCALAR >*, NodeId > gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::idMap__

private

Mapping between PRMInstance<GUM_SCALAR> dans their id in graph__.

Definition at line 257 of file interfaceGraph.h.

labels__

template<typename GUM_SCALAR >

Bijection< Idx, LabelData* >* gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::labels__

private

Bijection between labels and their ids.

Definition at line 263 of file interfaceGraph.h.

nodeMap__

template<typename GUM_SCALAR >

HashTable< LabelData*, Set< NodeData< GUM_SCALAR >* >* > gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::nodeMap__

private

Mapping between a LabelData and the set of NodeData<GUM_SCALAR> with that label.

Definition at line 268 of file interfaceGraph.h.

nodes__

template<typename GUM_SCALAR >

NodeProperty< NodeData< GUM_SCALAR >* > gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::nodes__

private

Data associated with a node in graph__.

Definition at line 254 of file interfaceGraph.h.

sys__

template<typename GUM_SCALAR >

const PRMSystem< GUM_SCALAR >* gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::sys__

private

The gum::prm::PRMSystem<GUM_SCALAR> represented by this interface graph.

Definition at line 248 of file interfaceGraph.h.

---

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

• agrum/PRM/gspan/interfaceGraph.h
• agrum/PRM/gspan/interfaceGraph_tpl.h