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

Private Member Functions
void	_label_ (NodeData< GUM_SCALAR > node, HashTable< std::string, LabelData > &label_map)
	Compute the label of node and add it to labels if it does not exists yet. Update node with the correct label's id.
void	_label_ (EdgeData< GUM_SCALAR > edge, HashTable< std::string, LabelData > &label_map)
	Compute the label of edge and add it to labels if it does not exists yet. Update edge with the correct label's id.

Private Attributes
const PRMSystem< GUM_SCALAR > *	_sys_
	The gum::prm::PRMSystem<GUM_SCALAR> represented by this interface graph.
UndiGraph	_graph_
	The interface graph.
NodeProperty< NodeData< GUM_SCALAR > * >	_nodes_
	Data associated with a node in graph.
HashTable< PRMInstance< GUM_SCALAR > *, NodeId >	_idMap_
	Mapping between PRMInstance<GUM_SCALAR> dans their id in graph.
EdgeProperty< EdgeData< GUM_SCALAR > * >	_edges_
	Data associated with edges in graph.
Bijection< Idx, LabelData * > *	_labels_
	Bijection between labels and their ids.
HashTable< LabelData , Set< NodeData< GUM_SCALAR > > * >	_nodeMap_
	Mapping between a LabelData and the set of NodeData<GUM_SCALAR> with that label.
HashTable< LabelData , Set< EdgeData< GUM_SCALAR > > * >	_edgeMap_
	Mapping between a LabelData and the set of EdgeData<GUM_SCALAR> with that label.
Idx	_counter_
	A counter used of assigning ids to labels.
bool	_erase_flag_
	For shallow copies.

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

Detailed Description

template<GUM_Numeric 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 182 of file interfaceGraph.h.

Constructor & Destructor Documentation

◆ InterfaceGraph() [1/2]

template<GUM_Numeric GUM_SCALAR>

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

explicit

Default constructor.

Definition at line 116 of file interfaceGraph_tpl.h.

                                                                                     :
          _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);
              }
            }
          }
        }
      }

References InterfaceGraph(), _counter_, _edges_, _erase_flag_, _graph_, _idMap_, _label_(), _labels_, _nodes_, _sys_, gum::prm::PRMSystem< GUM_SCALAR >::begin(), edge(), gum::prm::PRMSystem< GUM_SCALAR >::end(), gum::prm::gspan::NodeData< GUM_SCALAR >::l, gum::prm::gspan::NodeData< GUM_SCALAR >::n, and node().

Referenced by InterfaceGraph(), InterfaceGraph(), ~InterfaceGraph(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InterfaceGraph() [2/2]

template<GUM_Numeric 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 159 of file interfaceGraph_tpl.h.

                                                                                             :
          _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);
      }

References InterfaceGraph(), _counter_, _edgeMap_, _edges_, _erase_flag_, _graph_, _idMap_, _labels_, _nodeMap_, _nodes_, and _sys_.

Here is the call graph for this function:

◆ ~InterfaceGraph()

template<GUM_Numeric GUM_SCALAR>

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

Destructor.

Definition at line 169 of file interfaceGraph_tpl.h.

                                                    {
        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_;
      }

References InterfaceGraph(), _edgeMap_, _edges_, _erase_flag_, _labels_, _nodeMap_, and _nodes_.

Here is the call graph for this function:

Member Function Documentation

◆ _label_() [1/2]

template<GUM_Numeric 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 245 of file interfaceGraph_tpl.h.

                                                                                                {
        Size        size  = Size(1);
        std::string sBuff = std::format("{}-{}", 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 += std::format("-{}.{}", 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 += std::format("-{}.{}", edge->u->type().name(), chain->lastElt().name());
            size *= chain->lastElt().type().variable().domainSize();
          }
 
        // Label is ready
        auto p_elm = label_map.tryGet(sBuff);
        if (!p_elm) {
          LabelData* label = new LabelData();
          label_map.insert(sBuff, label);
          label->id         = ++_counter_;
          label->l          = sBuff;
          label->tree_width = size;
          _labels_->insert(label->id, label);
          _edgeMap_.insert(label, new Set< EdgeData< GUM_SCALAR >* >());
          p_elm = label_map.tryGet(sBuff);
        }
 
        edge->l = *p_elm;
        _edgeMap_[edge->l]->insert(edge);
      }

References _counter_, _edgeMap_, _labels_, edge(), gum::HashTable< Key, Val >::insert(), label(), size(), and gum::HashTable< Key, Val >::tryGet().

Here is the call graph for this function:

◆ _label_() [2/2]

template<GUM_Numeric 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 200 of file interfaceGraph_tpl.h.

                                                                                                {
        Size        size  = Size(1);
        std::string sBuff = node->n->type().name();
 
        // First we search for multiple inputs
        for (const auto chain: node->n->type().slotChains()) {
          if (chain->isMultiple()) {
            sBuff += std::format("-{}{}", node->n->getInstances(chain->id()).size(), 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))) {
            if (node->n->hasRefAttr(nn) && node->n->exists(nn)) {
              sBuff
                  += std::format("-{}{}", node->n->getRefAttr(nn).size(), node->n->get(nn).name());
              size *= node->n->get(nn).type().variable().domainSize();
            }
          }
        }
 
        // Label is ready
        auto p_lm = label_map.tryGet(sBuff);
        if (!p_lm) {
          LabelData* label = new LabelData();
          label_map.insert(sBuff, label);
          label->id         = ++_counter_;
          label->tree_width = size;
          label->l          = sBuff;
          _labels_->insert(label->id, label);
          _nodeMap_.insert(label, new Set< NodeData< GUM_SCALAR >* >());
          p_lm = label_map.tryGet(sBuff);
        }
 
        node->l = *p_lm;
        _nodeMap_[node->l]->insert(node);
      }

References _counter_, _labels_, _nodeMap_, gum::HashTable< Key, Val >::insert(), label(), node(), size(), and gum::HashTable< Key, Val >::tryGet().

Referenced by InterfaceGraph().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ edge() [1/2]

template<GUM_Numeric GUM_SCALAR>

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

Returns data about an edge.

Exceptions

NotFound

Definition at line 368 of file interfaceGraph_tpl.h.

                                                                                   {
        if (auto p = _edges_.tryGet(Edge(u, v))) return *(*p);
        return *(_edges_[Edge(v, u)]);
      }

References _edges_.

Referenced by InterfaceGraph(), _label_(), and gum::prm::GSpan< GUM_SCALAR >::_subgraph_mining_().

Here is the caller graph for this function:

◆ edge() [2/2]

template<GUM_Numeric GUM_SCALAR>

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 374 of file interfaceGraph_tpl.h.

                                                                                               {
        if (auto p = _edges_.tryGet(Edge(u, v))) return *(*p);
        return *(_edges_[Edge(v, u)]);
      }

References _edges_.

◆ edges() [1/2]

template<GUM_Numeric GUM_SCALAR>

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 320 of file interfaceGraph_tpl.h.

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

References _edgeMap_.

◆ edges() [2/2]

template<GUM_Numeric GUM_SCALAR>

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 326 of file interfaceGraph_tpl.h.

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

References _edgeMap_.

◆ id() [1/2]

template<GUM_Numeric GUM_SCALAR>

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 336 of file interfaceGraph_tpl.h.

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

References _idMap_.

Referenced by gum::prm::GSpan< GUM_SCALAR >::_subgraph_mining_(), node(), and node().

Here is the caller graph for this function:

◆ id() [2/2]

template<GUM_Numeric GUM_SCALAR>

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 341 of file interfaceGraph_tpl.h.

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

References _idMap_.

◆ internalGraph() [1/2]

template<GUM_Numeric GUM_SCALAR>

UndiGraph & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::internalGraph ( )

Returns the graph of this interface graph.

Definition at line 283 of file interfaceGraph_tpl.h.

                                                             {
        return _graph_;
      }

References _graph_.

Referenced by gum::prm::GSpan< GUM_SCALAR >::_subgraph_mining_().

Here is the caller graph for this function:

◆ internalGraph() [2/2]

template<GUM_Numeric GUM_SCALAR>

const UndiGraph & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::internalGraph ( ) const

Returns the graph of this interface graph.

Definition at line 288 of file interfaceGraph_tpl.h.

                                                                         {
        return _graph_;
      }

References _graph_.

◆ label()

template<GUM_Numeric GUM_SCALAR>

LabelData * gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::label ( Idx id )

Returns a label given its id.

Definition at line 331 of file interfaceGraph_tpl.h.

                                                           {
        return _labels_->second(id);
      }

References _labels_.

Referenced by _label_(), and _label_().

Here is the caller graph for this function:

◆ labels() [1/2]

template<GUM_Numeric GUM_SCALAR>

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

Returns the bijection between LabelData and their string representation.

Definition at line 293 of file interfaceGraph_tpl.h.

                                                                         {
        return *_labels_;
      }

References _labels_.

◆ labels() [2/2]

template<GUM_Numeric GUM_SCALAR>

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

Returns the bijection between LabelData and their string representation.

Definition at line 298 of file interfaceGraph_tpl.h.

                                                                                     {
        return *_labels_;
      }

References _labels_.

◆ node() [1/4]

template<GUM_Numeric GUM_SCALAR>

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.

                                                                               {
        return node(id(i));
      }

References node().

Referenced by InterfaceGraph(), _label_(), gum::prm::GSpan< GUM_SCALAR >::_subgraph_mining_(), node(), and node().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ node() [2/4]

template<GUM_Numeric GUM_SCALAR>

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 353 of file interfaceGraph_tpl.h.

                                                                                     {
        return node(id(i));
      }

References node().

Here is the call graph for this function:

◆ node() [3/4]

template<GUM_Numeric GUM_SCALAR>

NodeData< GUM_SCALAR > & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::node ( NodeId id )

Returns data about a node.

Exceptions

NotFound

Definition at line 358 of file interfaceGraph_tpl.h.

                                                                          {
        return *(_nodes_[id]);
      }

References _nodes_, and id().

Here is the call graph for this function:

◆ node() [4/4]

template<GUM_Numeric GUM_SCALAR>

const NodeData< GUM_SCALAR > & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::node ( NodeId id ) const

Returns data about a node.

Exceptions

NotFound

Definition at line 363 of file interfaceGraph_tpl.h.

                                                                                      {
        return *(_nodes_[id]);
      }

References _nodes_, and id().

Here is the call graph for this function:

◆ nodes() [1/2]

template<GUM_Numeric GUM_SCALAR>

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 309 of file interfaceGraph_tpl.h.

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

References _nodeMap_.

◆ nodes() [2/2]

template<GUM_Numeric GUM_SCALAR>

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 315 of file interfaceGraph_tpl.h.

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

References _nodeMap_.

◆ operator=()

template<GUM_Numeric GUM_SCALAR>

InterfaceGraph< GUM_SCALAR > & gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::operator= ( const InterfaceGraph< GUM_SCALAR > & source )

Copy operator.

Definition at line 195 of file interfaceGraph_tpl.h.

                                                                                          {
        GUM_ERROR(FatalError, "not implemented")
      }

References InterfaceGraph(), and GUM_ERROR.

Here is the call graph for this function:

◆ size()

template<GUM_Numeric GUM_SCALAR>

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 303 of file interfaceGraph_tpl.h.

                                                                      {
        if (auto p = _nodeMap_.tryGet(const_cast< LabelData* >(l))) return (*p)->size();
        return _edgeMap_[const_cast< LabelData* >(l)]->size();
      }