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 164 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 94 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 137 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 147 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

_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 178 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 224 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:

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 349 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 356 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 301 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 307 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 261 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 266 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 317 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 322 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 312 of file interfaceGraph_tpl.h.

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

                                                                  {
        return _labels_->second(id);
      }

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 271 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 276 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 328 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 334 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 339 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 344 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 289 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 295 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 173 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 281 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 165 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 273 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 270 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 257 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 276 of file interfaceGraph.h.

_graph_

template<typename GUM_SCALAR >

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

private

The interface graph.

Definition at line 248 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 254 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 260 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 265 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 251 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 245 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