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

A DFSTree is used by gspan to sort lexicographically patterns discovered in an interface graph. More...

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

Inheritance diagram for gum::prm::gspan::DFSTree< GUM_SCALAR >:

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

Public Member Functions
Constructor and destructor.
	DFSTree (const InterfaceGraph< GUM_SCALAR > &graph, SearchStrategy< GUM_SCALAR > *strategy=0)
	Default constructor. More...
	~DFSTree ()
	Destructor. More...
DFSTree getters and setters.
const InterfaceGraph< GUM_SCALAR > &	graph () const
	Returns the list of root patterns in this DFSTree. More...
std::list< NodeId > &	roots ()
	Returns the list of root patterns in this DFSTree. More...
const std::list< NodeId > &	roots () const
	Returns the list of root patterns in this DFSTree. More...
Pattern &	parent (const Pattern &p)
	Returns the parent of p in this DFSTree. More...
const Pattern &	parent (const Pattern &p) const
	Returns the parent of p in this DFSTree. More...
std::list< NodeId > &	children (const Pattern &p)
	Returns the list of p children in this DFSTree. More...
const std::list< NodeId > &	children (const Pattern &p) const
	Returns the list of p children in this DFSTree. More...
Pattern &	pattern (NodeId id)
	Returns the pattern represented by id in this DFSTree. More...
const Pattern &	pattern (NodeId id) const
	Returns the pattern represented by id in this DFSTree. More...
void	addRoot (LabelData &data)
	Add a one edge Pattern in this DFSTree. More...
Pattern &	growPattern (Pattern &p, EdgeGrowth< GUM_SCALAR > &edge_growth, Size min_freq)
	Add a one edge growth of p as one of its child. More...
Isomorphisms for patterns in this DFSTree.
UndiGraph &	iso_graph (const Pattern &p)
	Returns the isomorphism graph of p in the interface graph. More...
Sequence< PRMInstance< GUM_SCALAR > *> &	iso_map (const Pattern &p, NodeId node)
	Given a pattern and a node in its isomorphism graph, this methods returns the sequence of instance matching p in the interface graph. More...
Set< NodeId > &	max_indep_set (const Pattern &p)
	Returns the maximal independent set of p isomorphism graph. More...
double	frequency (const Pattern &p) const
	Returns the frequency of p respecting it's maximal independent set. More...
PatternData &	data (const Pattern &p)
const PatternData &	data (const Pattern &p) const
SearchStrategy< GUM_SCALAR > &	strategy ()
	strategy getter More...
const SearchStrategy< GUM_SCALAR > &	strategy () const
	strategy getter More...

Classes
class	NeighborDegreeSort
	This is used to generate the max_indep_set of a Pattern. More...
struct	PatternData

Detailed Description

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

A DFSTree is used by gspan to sort lexicographically patterns discovered in an interface graph.

Definition at line 70 of file DFSTree.h.

Member Typedef Documentation

ArcIterator

typedef ArcSetIterator gum::ArcGraphPart::ArcIterator

inherited

Definition at line 80 of file arcGraphPart.h.

node_const_iterator

using gum::NodeGraphPart::node_const_iterator = NodeGraphPartIterator

inherited

types for STL compliance

Definition at line 258 of file nodeGraphPart.h.

node_const_iterator_safe

using gum::NodeGraphPart::node_const_iterator_safe = NodeGraphPartIteratorSafe

inherited

types for STL compliance

Definition at line 260 of file nodeGraphPart.h.

node_iterator

using gum::NodeGraphPart::node_iterator = NodeGraphPartIterator

inherited

types for STL compliance

Definition at line 257 of file nodeGraphPart.h.

node_iterator_safe

using gum::NodeGraphPart::node_iterator_safe = NodeGraphPartIteratorSafe

inherited

types for STL compliance

Definition at line 259 of file nodeGraphPart.h.

NodeConstIterator

typedef NodeGraphPartIterator gum::NodeGraphPart::NodeConstIterator

inherited

Definition at line 267 of file nodeGraphPart.h.

NodeConstIteratorSafe

typedef NodeGraphPartIteratorSafe gum::NodeGraphPart::NodeConstIteratorSafe

inherited

Definition at line 269 of file nodeGraphPart.h.

NodeIterator

typedef NodeGraphPartIterator gum::NodeGraphPart::NodeIterator

inherited

Definition at line 266 of file nodeGraphPart.h.

NodeIteratorSafe

typedef NodeGraphPartIteratorSafe gum::NodeGraphPart::NodeIteratorSafe

inherited

Definition at line 268 of file nodeGraphPart.h.

Constructor & Destructor Documentation

DFSTree()

template<typename GUM_SCALAR >

INLINE gum::prm::gspan::DFSTree< GUM_SCALAR >::DFSTree	(	const InterfaceGraph< GUM_SCALAR > &	graph,
		gspan::SearchStrategy< GUM_SCALAR > *	strategy = 0
	)

Default constructor.

Definition at line 381 of file DFSTree_tpl.h.

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

                                                      :
          graph__(&graph),
          strategy__(strategy) {
        GUM_CONSTRUCTOR(DFSTree);

        if (!strategy__) strategy__ = new FrequenceSearch< GUM_SCALAR >(2);

        strategy__->setTree(this);
      }

Here is the call graph for this function:

~DFSTree()

template<typename GUM_SCALAR >

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

(

)

Destructor.

Definition at line 36 of file DFSTree_tpl.h.

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

                                      {
        GUM_DESTRUCTOR(DFSTree);

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

        delete strategy__;
      }

Here is the call graph for this function:

Member Function Documentation

addArc()

INLINE void gum::DiGraph::addArc ( const NodeId  tail, const NodeId  head  )

virtualinherited

insert a new arc into the directed graph

Parameters

tail	the id of the tail of the new inserted arc
head	the id of the head of the new inserted arc

Warning

if the arc already exists, nothing is done. In particular, no exception is raised.

Exceptions

InvalidNode

if head or tail does not belong to the graph nodes

Reimplemented from gum::ArcGraphPart.

Reimplemented in gum::DAG.

Definition at line 34 of file diGraph_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                  {
    if (!exists(head)) { GUM_ERROR(InvalidNode, "no head node : " << head); }

    if (!exists(tail)) { GUM_ERROR(InvalidNode, "no tail node : " << tail); }

    ArcGraphPart::addArc(tail, head);
  }

Here is the call graph for this function:

addChild__()

template<typename GUM_SCALAR >

void gum::prm::gspan::DFSTree< GUM_SCALAR >::addChild__ ( Pattern &  p, Pattern *  child, EdgeGrowth< GUM_SCALAR > &  edge_growth  )

private

Add a child to this DFSTree.

Definition at line 162 of file DFSTree_tpl.h.

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

                                                                                  {
        // Adding child to the tree
        NodeId node = DiGraph::addNode();
        node_map__.insert(node, child);
        // Adding child in p's children list
        std::list< NodeId >& children = data__[&p]->children;

        if (children.empty()) {
          children.push_back(node);
        } else {
          size_t size = children.size();

          for (std::list< NodeId >::iterator iter = children.begin();
               iter != children.end();
               ++iter) {
            if (child->code() < pattern(*iter).code()) {
              children.insert(iter, node);
              break;
            }
          }

          if (size == children.size()) { children.push_back(node); }
        }
      }

Here is the call graph for this function:

addNode()

INLINE NodeId gum::NodeGraphPart::addNode ( )

virtualinherited

insert a new node and return its id

Returns

the id chosen by the internal idFactory

Reimplemented in gum::CliqueGraph.

Definition at line 252 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                       {
    NodeId newNode;

    // fill the first hole if holes exist
    if (holes__ && (!holes__->empty())) {
      newNode = *(holes__->begin());
      eraseHole__(newNode);
    } else {
      newNode = boundVal__;
      ++boundVal__;
      updateEndIteratorSafe__();
    }

    GUM_EMIT1(onNodeAdded, newNode);

    return newNode;
  }

Here is the call graph for this function:

addNodes()

INLINE std::vector< NodeId > gum::NodeGraphPart::addNodes ( Size  n )

inherited

insert n nodes

Parameters

n	the number of nodes to add

Returns

the vector of chosen ids

Definition at line 270 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                           {
    std::vector< NodeId > v;
    v.reserve(N);
    for (Idx i = 0; i < N; i++)
      v.push_back(this->addNode());
    return v;
  }

Here is the call graph for this function:

addNodeWithId()

void gum::NodeGraphPart::addNodeWithId ( const NodeId  id )

virtualinherited

try to insert a node with the given id

Warning

This method should be carefully used. Please prefer populateNodes or populateNodesFromProperty when possible

Exceptions

DuplicateElement

exception if the id already exists

Definition at line 131 of file nodeGraphPart.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                   {
    if (id >= boundVal__) {
      if (id > boundVal__) {   // we have to add holes
        if (!holes__) holes__ = new NodeSet(holes_size__, holes_resize_policy__);

        for (NodeId i = boundVal__; i < id; ++i)
          holes__->insert(i);
      }

      boundVal__ = id + 1;

      updateEndIteratorSafe__();
    } else {
      if (inHoles__(id)) {   // we fill a hole
        eraseHole__(id);
      } else {
        GUM_ERROR(DuplicateElement, "Id " << id << " is already used");
      }
    }

    GUM_EMIT1(onNodeAdded, id);
  }

Here is the call graph for this function:

addRoot()

template<typename GUM_SCALAR >

void gum::prm::gspan::DFSTree< GUM_SCALAR >::addRoot

(

LabelData &

data

)

Add a one edge Pattern in this DFSTree.

Parameters

data	Data over the edge used to create a root of this DFSTree.

Returns

Returns the Pattern added as a root of this DFSTree.

Definition at line 48 of file DFSTree_tpl.h.

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

                                                          {
        HashTable< Pattern*, std::pair< Idx, Idx > >                roots;
        HashTable< Pattern*, Sequence< EdgeData< GUM_SCALAR >* >* > roots_edges;

        for (const auto& edge: graph__->edges(&label)) {
          bool u_first = (edge->l_u->id < edge->l_v->id);
          Idx  u_idx   = (u_first) ? edge->l_u->id : edge->l_v->id;
          Idx  v_idx   = (!u_first) ? edge->l_u->id : edge->l_v->id;

          bool found = false;

          for (const auto& elt: roots)
            if ((elt.second.first == u_idx) && (elt.second.second == v_idx)) {
              roots_edges[elt.first]->insert(edge);
              found = true;
              break;
            }

          if (!found) {
            Pattern* p = new Pattern();
            roots.insert(p, std::make_pair(u_idx, v_idx));
            roots_edges.insert(p, new Sequence< EdgeData< GUM_SCALAR >* >());
            roots_edges[p]->insert(edge);
            DFSTree< GUM_SCALAR >::PatternData* data
               = new DFSTree< GUM_SCALAR >::PatternData(p);
            NodeId u = p->addNodeWithLabel((u_first) ? *edge->l_u : *edge->l_v);
            NodeId v = p->addNodeWithLabel((!u_first) ? *edge->l_u : *edge->l_v);
            p->addArc(u, v, label);
            node_map__.insert(DiGraph::addNode(), p);
            data__.insert(p, data);
            roots__.push_back(node_map__.first(p));
          }
        }

        // This is used to compute the max independent set of p->max_indep_set
        for (const auto& elt: roots_edges) {
          initialiaze_root__(elt.first, *elt.second);
          strategy().accept_root(elt.first);
          delete elt.second;
        }
      }

Here is the call graph for this function:

ancestors()

NodeSet gum::ArcGraphPart::ancestors ( NodeId  id ) const

inherited

returns the set of nodes with directed path ingoing to a given node

Note that the set of nodes returned may be empty if no path within the ArcGraphPart is ingoing to the given node.

Parameters

id	the node which is the head of a directed path with the returned nodes

Definition at line 172 of file arcGraphPart.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                 {
    NodeSet res;
    NodeSet tmp;
    for (auto next: parents(id))
      tmp.insert(next);

    while (!tmp.empty()) {
      auto current = *(tmp.begin());
      tmp.erase(current);
      res.insert(current);
      for (auto next: parents(current)) {
        if (!tmp.contains(next) && !res.contains(next)) { tmp.insert(next); }
      }
    }
    return res;
  }

Here is the call graph for this function:

arcs()

INLINE const ArcSet & gum::ArcGraphPart::arcs ( ) const

inherited

returns the set of arcs stored within the ArcGraphPart

Definition at line 38 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return arcs__; }

Here is the call graph for this function:

arcsProperty() [1/2]

template<typename VAL >

ArcProperty< VAL > gum::ArcGraphPart::arcsProperty ( VAL(*)(const Arc &)  f, Size  size = 0  ) const

inherited

a method to create a hashMap of VAL from a set of arcs (using for every arc, say x, the VAL f(x))

Parameters

f	a function assigning a VAL to any arc
size	an optional parameter enabling to fine-tune the returned Property. Roughly speaking, it is a good practice to have a size equal to half the number of arcs. If you do not specify this parameter, the method will assign it for you.

arcsProperty() [2/2]

template<typename VAL >

ArcProperty< VAL > gum::ArcGraphPart::arcsProperty ( const VAL &  a, Size  size = 0  ) const

inherited

a method to create a hashMap of VAL from a set of arcs (using for every arc, say x, the VAL a)

Parameters

a	the default value assigned to each arc in the returned Property
size	an optional parameter enabling to fine-tune the returned Property. Roughly speaking, it is a good practice to have a size equal to half the number of arcs. If you do not specify this parameter, the method will assign it for you.

asNodeSet()

INLINE NodeSet gum::NodeGraphPart::asNodeSet ( ) const

inherited

returns a copy of the set of nodes represented by the NodeGraphPart

Warning

this function is o(n) where n is the number of nodes. In space and in time. Usually, when you need to parse the nodes of a NodeGraphPart, prefer using

for(const auto n : nodes()) 

rather than

for(const auto n : asNodeSet()) 

as this is faster and consumes much less memory.

Definition at line 360 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                {
    NodeSet son(sizeNodes());

    if (!empty()) {
      for (NodeId n = 0; n < boundVal__; ++n) {
        if (!inHoles__(n)) son.insert(n);
      }
    }

    return son;
  }

Here is the call graph for this function:

begin()

INLINE NodeGraphPartIterator gum::NodeGraphPart::begin ( ) const

noexceptinherited

a begin iterator to parse the set of nodes contained in the NodeGraphPart

Definition at line 332 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                   {
    NodeGraphPartIterator it(*this);
    it.validate_();   // stop the iterator at the first not-in-holes
    return it;
  }

Here is the call graph for this function:

beginSafe()

INLINE NodeGraphPartIteratorSafe gum::NodeGraphPart::beginSafe ( ) const

inherited

a begin iterator to parse the set of nodes contained in the NodeGraphPart

Definition at line 318 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                  {
    NodeGraphPartIteratorSafe it(*this);
    it.validate_();   // stop the iterator at the first not-in-holes
    return it;
  }

Here is the call graph for this function:

bound()

INLINE NodeId gum::NodeGraphPart::bound ( ) const

inherited

returns a number n such that all node ids are strictly lower than n

Definition at line 307 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return boundVal__; }

Here is the call graph for this function:

checkGrowth__()

template<typename GUM_SCALAR >

void gum::prm::gspan::DFSTree< GUM_SCALAR >::checkGrowth__ ( Pattern &  p, Pattern *  child, EdgeGrowth< GUM_SCALAR > &  edge_growth  )

private

Raise different exceptions if child is invalid or illegal.

Definition at line 190 of file DFSTree_tpl.h.

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

                                                {
        NodeId v = edge_growth.v;

        // First we check if the edge is legal
        if (v == 0) { v = child->addNodeWithLabel(*(edge_growth.l_v)); }

        child->addArc(edge_growth.u, v, *(edge_growth.edge));
        // Neighborhood restriction is checked by the Pattern class
        EdgeCode& edge = child->edgeCode(edge_growth.u, v);

        // Then we check if the edge we added is valid
        if (edge < *(child->code().codes.front())) {
          GUM_ERROR(OperationNotAllowed,
                    "added edge code is lesser than the first "
                    "one in the pattern's DFSCode");
        }

        if (edge.isBackward()) {
          typedef std::vector< EdgeCode* >::iterator EdgeIter;

          for (EdgeIter iter = child->code().codes.begin();
               (iter + 1) != child->code().codes.end();
               ++iter) {
            if ((((**iter).i == v) || ((**iter).j == v)) && edge < (**iter)) {
              GUM_ERROR(
                 OperationNotAllowed,
                 "added backward edge is lesser than an existing edge on v");
            }
          }
        }

        // Finally we check if child is minimal.
        if (!child->isMinimal()) {
          GUM_ERROR(OperationNotAllowed,
                    "the DFSCode for this growth is not minimal");
        }
      }

Here is the call graph for this function:

children() [1/4]

template<typename GUM_SCALAR >

INLINE std::list< NodeId > & gum::prm::gspan::DFSTree< GUM_SCALAR >::children

(

const Pattern &

p

)

Returns the list of p children in this DFSTree.

Definition at line 435 of file DFSTree_tpl.h.

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

                                                             {
        try {
          return data__[const_cast< Pattern* >(&p)]->children;
        } catch (NotFound&) {
          GUM_ERROR(NotFound, "pattern not found in this DFSTree");
        }
      }

Here is the call graph for this function:

children() [2/4]

template<typename GUM_SCALAR >

INLINE const std::list< NodeId > & gum::prm::gspan::DFSTree< GUM_SCALAR >::children

(

const Pattern &

p

)

const

Returns the list of p children in this DFSTree.

Definition at line 445 of file DFSTree_tpl.h.

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

                                                                         {
        try {
          return data__[const_cast< Pattern* >(&p)]->children;
        } catch (NotFound&) {
          GUM_ERROR(NotFound, "pattern not found in this DFSTree");
        }
      }

Here is the call graph for this function:

children() [3/4]

INLINE NodeSet gum::ArcGraphPart::children ( const NodeSet &  ids ) const

inherited

returns the set of children of a set of nodes

Definition at line 68 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                {
    NodeSet res;
    for (const auto node: ids)
      res += children(node);
    return res;
  }

Here is the call graph for this function:

children() [4/4]

INLINE const NodeSet & gum::ArcGraphPart::children ( NodeId  id ) const

inherited

returns the set of nodes with arc outgoing from a given node

Note that the set of arcs returned may be empty if no arc within the ArcGraphPart is outgoing from the given node.

Parameters

id	the node which is the tail of the arcs returned

Definition at line 91 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                              {
    checkChildren__(id);
    return *(children__[id]);
  }

Here is the call graph for this function:

clear()

INLINE void gum::DiGraph::clear ( )

virtualinherited

removes all the nodes and arcs from the graph

Reimplemented from gum::NodeGraphPart.

Reimplemented in gum::MixedGraph.

Definition at line 42 of file diGraph_inl.h.

References gum::Set< Key, Alloc >::emplace().

                             {
    ArcGraphPart::clearArcs();
    NodeGraphPart::clearNodes();
  }

Here is the call graph for this function:

clearArcs()

void gum::ArcGraphPart::clearArcs ( )

inherited

removes all the arcs from the ArcGraphPart

Definition at line 78 of file arcGraphPart.cpp.

References gum::Set< Key, Alloc >::emplace().

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

    parents__.clear();

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

    children__.clear();

    // we need this copy only if at least one onArcDeleted listener exists
    if (onArcDeleted.hasListener()) {
      ArcSet tmp = arcs__;
      arcs__.clear();

      for (const auto& arc: tmp)
        GUM_EMIT2(onArcDeleted, arc.tail(), arc.head());
    } else {
      arcs__.clear();
    }
  }

Here is the call graph for this function:

clearNodes()

INLINE void gum::NodeGraphPart::clearNodes ( )

virtualinherited

remove all the nodes from the NodeGraphPart

Definition at line 309 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ clearNodes__(); }

Here is the call graph for this function:

data() [1/2]

template<typename GUM_SCALAR >

INLINE DFSTree< GUM_SCALAR >::PatternData & gum::prm::gspan::DFSTree< GUM_SCALAR >::data

(

const Pattern &

p

)

Parameters

p	The pattern

Definition at line 525 of file DFSTree_tpl.h.

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

                                                     {
        return *(data__[const_cast< Pattern* >(&p)]);
      }

Here is the call graph for this function:

data() [2/2]

template<typename GUM_SCALAR >

INLINE const DFSTree< GUM_SCALAR >::PatternData & gum::prm::gspan::DFSTree< GUM_SCALAR >::data

(

const Pattern &

p

)

const

Parameters

p	The pattern

Definition at line 531 of file DFSTree_tpl.h.

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

                                                           {
        return *(data__[const_cast< Pattern* >(&p)]);
      }

Here is the call graph for this function:

descendants()

NodeSet gum::ArcGraphPart::descendants ( NodeId  id ) const

inherited

returns the set of nodes with directed path outgoing from a given node

Note that the set of nodes returned may be empty if no path within the ArcGraphPart is outgoing from the given node.

Parameters

id	the node which is the tail of a directed path with the returned nodes

Definition at line 154 of file arcGraphPart.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                   {
    NodeSet res;
    NodeSet tmp;
    for (auto next: children(id))
      tmp.insert(next);

    while (!tmp.empty()) {
      auto current = *(tmp.begin());
      tmp.erase(current);
      res.insert(current);
      for (auto next: children(current)) {
        if (!tmp.contains(next) && !res.contains(next)) { tmp.insert(next); }
      }
    }
    return res;
  }

Here is the call graph for this function:

directedPath()

std::vector< NodeId > gum::ArcGraphPart::directedPath ( NodeId  node1, NodeId  node2  ) const

inherited

returns a directed path from node1 to node2 belonging to the set of arcs

Parameters

node1	the id from which the path begins
node2	the id to which the path ends

Exceptions

NotFound

exception is raised if no path can be found between the two nodes

Definition at line 190 of file arcGraphPart.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                                           {
    // not recursive version => use a FIFO for simulating the recursion
    List< NodeId > nodeFIFO;
    nodeFIFO.pushBack(n2);

    // mark[node] = successor if visited, else mark[node] does not exist
    NodeProperty< NodeId > mark;
    mark.insert(n2, n2);

    NodeId current;

    while (!nodeFIFO.empty()) {
      current = nodeFIFO.front();
      nodeFIFO.popFront();

      // check the parents

      for (const auto new_one: parents(current)) {
        if (mark.exists(new_one))   // if this node is already marked, do not
          continue;                 // check it again

        mark.insert(new_one, current);

        if (new_one == n1) {
          std::vector< NodeId > v;

          for (current = n1; current != n2; current = mark[current])
            v.push_back(current);

          v.push_back(n2);

          return v;
        }

        nodeFIFO.pushBack(new_one);
      }
    }

    GUM_ERROR(NotFound, "no path found");
  }

Here is the call graph for this function:

directedUnorientedPath()

std::vector< NodeId > gum::ArcGraphPart::directedUnorientedPath ( NodeId  node1, NodeId  node2  ) const

inherited

returns an unoriented (directed) path from node1 to node2 in the arc set

Parameters

node1	the id from which the path begins
node2	the id to which the path ends

Exceptions

NotFound

exception is raised if no path can be found between the two nodes

Definition at line 231 of file arcGraphPart.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                                              {
    // not recursive version => use a FIFO for simulating the recursion
    List< NodeId > nodeFIFO;
    nodeFIFO.pushBack(n2);

    // mark[node] = successor if visited, else mark[node] does not exist
    NodeProperty< NodeId > mark;
    mark.insert(n2, n2);

    NodeId current;

    while (!nodeFIFO.empty()) {
      current = nodeFIFO.front();
      nodeFIFO.popFront();

      // check the parents
      for (const auto new_one: parents(current)) {
        if (mark.exists(new_one))   // the node has already been visited
          continue;

        mark.insert(new_one, current);

        if (new_one == n1) {
          std::vector< NodeId > v;

          for (current = n1; current != n2; current = mark[current])
            v.push_back(current);

          v.push_back(n2);

          return v;
        }

        nodeFIFO.pushBack(new_one);
      }

      // check the children
      for (const auto new_one: children(current)) {
        if (mark.exists(new_one))   // the node has already been visited
          continue;

        mark.insert(new_one, current);

        if (new_one == n1) {
          std::vector< NodeId > v;

          for (current = n1; current != n2; current = mark[current])
            v.push_back(current);

          v.push_back(n2);

          return v;
        }

        nodeFIFO.pushBack(new_one);
      }
    }

    GUM_ERROR(NotFound, "no path found");
  }

Here is the call graph for this function:

empty()

INLINE bool gum::NodeGraphPart::empty ( ) const

inherited

alias for emptyNodes

Definition at line 305 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return emptyNodes(); }

Here is the call graph for this function:

emptyArcs()

INLINE bool gum::ArcGraphPart::emptyArcs ( ) const

inherited

indicates wether the ArcGraphPart contains any arc

Definition at line 34 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return arcs__.empty(); }

Here is the call graph for this function:

emptyNodes()

INLINE bool gum::NodeGraphPart::emptyNodes ( ) const

inherited

indicates whether there exists nodes in the NodeGraphPart

Definition at line 303 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return (sizeNodes() == 0); }

Here is the call graph for this function:

end()

INLINE const NodeGraphPartIterator & gum::NodeGraphPart::end ( ) const

noexceptinherited

the end iterator to parse the set of nodes contained in the NodeGraphPart

Definition at line 338 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                        {
    return endIteratorSafe__;
  }

Here is the call graph for this function:

endSafe()

INLINE const NodeGraphPartIteratorSafe & gum::NodeGraphPart::endSafe ( ) const

noexceptinherited

the end iterator to parse the set of nodes contained in the NodeGraphPart

Definition at line 328 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                {
    return endIteratorSafe__;
  }

Here is the call graph for this function:

eraseArc()

INLINE void gum::ArcGraphPart::eraseArc ( const Arc &  arc )

virtualinherited

removes an arc from the ArcGraphPart

Parameters

arc	the arc to be removed

Warning

if the arc does not exist, nothing is done. In particular, no exception is thrown. However, the signal onArcDeleted is fired only if a node is effectively removed.

Definition at line 108 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                   {
    // ASSUMING tail and head exists in parents__ anf children__
    // (if not, it is an error)
    if (existsArc(arc)) {
      NodeId tail = arc.tail(), head = arc.head();
      parents__[head]->erase(tail);
      children__[tail]->erase(head);
      arcs__.erase(arc);
      GUM_EMIT2(onArcDeleted, tail, head);
    }
  }

Here is the call graph for this function:

eraseChildren()

INLINE void gum::ArcGraphPart::eraseChildren ( NodeId  id )

inherited

removes all the children of a given node

Parameters

id	the node all the children of which will be removed

Warning

although this method is not virtual, it calls method eraseArc( const Arc& arc ) and, as such, has a "virtual" behaviour. If you do not wish it to have this "virtual" behaviour, call instead method unvirtualizedEraseChildren

if no arc is a parent of id, nothing is done. In particular, no exception is thrown.

Definition at line 139 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                   {
    if (children__.exists(id)) {
      NodeSet& children = *(children__[id]);

      for (auto iter = children.beginSafe();   // safe iterator needed here
           iter != children.endSafe();
           ++iter) {
        // warning: use this erase so that you actually use the vritualized
        // arc removal function
        eraseArc(Arc(id, *iter));
      }
    }
  }

Here is the call graph for this function:

eraseNode()

INLINE void gum::DiGraph::eraseNode ( const NodeId  id )

virtualinherited

remove a node and its adjacent arcs from the graph

Parameters

id	the id of the node to be removed

Warning

if the node does not exist, nothing is done. In particular, no exception is raised.

Reimplemented from gum::NodeGraphPart.

Reimplemented in gum::MixedGraph.

Definition at line 68 of file diGraph_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                {
    // warning: to remove the arcs adjacent to id, use the unvirtualized
    // versions
    // of arc removals
    ArcGraphPart::unvirtualizedEraseParents(id);
    ArcGraphPart::unvirtualizedEraseChildren(id);

    NodeGraphPart::eraseNode(id);
  }

Here is the call graph for this function:

eraseParents()

INLINE void gum::ArcGraphPart::eraseParents ( NodeId  id )

inherited

erase all the parents of a given node

Parameters

id	the node all the parents of which will be removed

Warning

although this method is not virtual, it calls method eraseArc( const Arc& arc ) and, as such, has a "virtual" behaviour. If you do not wish it to have this "virtual" behaviour, call instead method unvirtualizedEraseParents

if no arc is a parent of id, nothing is done. In particular, no exception is thrown.

Definition at line 125 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                  {
    if (parents__.exists(id)) {
      NodeSet& parents = *(parents__[id]);

      for (auto iter = parents.beginSafe();   // safe iterator needed here
           iter != parents.endSafe();
           ++iter) {
        // warning: use this erase so that you actually use the virtualized
        // arc removal function
        eraseArc(Arc(*iter, id));
      }
    }
  }

Here is the call graph for this function:

eraseSetOfArcs_()

INLINE void gum::ArcGraphPart::eraseSetOfArcs_ ( const ArcSet &  set )

protectedinherited

a (virtualized) function to remove a given set of arcs

Warning

this function uses eraseArc, which is a virtual function. Hence the behaviour of this function is that of a virtual function

Definition at line 120 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                             {
    for (const auto& arc: set)
      eraseArc(arc);
  }

Here is the call graph for this function:

exists()

INLINE bool gum::NodeGraphPart::exists ( const NodeId  id ) const

inherited

alias for existsNode

Definition at line 291 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                           {
    return existsNode(node);
  }

Here is the call graph for this function:

existsArc() [1/2]

INLINE bool gum::ArcGraphPart::existsArc ( const Arc &  arc ) const

inherited

indicates whether a given arc exists

Parameters

arc	the arc we test whether or not it belongs to the ArcGraphPart

Definition at line 40 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                          {
    return arcs__.contains(arc);
  }

Here is the call graph for this function:

existsArc() [2/2]

INLINE bool gum::ArcGraphPart::existsArc ( NodeId  tail, NodeId  head  ) const

inherited

indicates whether a given arc exists

Parameters

tail	the tail of the arc we test the existence in the ArcGraphPart
head	the head of the arc we test the existence in the ArcGraphPart

Definition at line 44 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                    {
    return parents__.exists(head) && parents__[head]->exists(tail);
  }

Here is the call graph for this function:

existsNode()

INLINE bool gum::NodeGraphPart::existsNode ( const NodeId  id ) const

inherited

returns true iff the NodeGraphPart contains the given nodeId

Definition at line 285 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                               {
    if (node >= boundVal__) return false;

    return (!inHoles__(node));
  }

Here is the call graph for this function:

family() [1/2]

INLINE NodeSet gum::ArcGraphPart::family ( NodeId  id ) const

inherited

returns the set of nodes which consists in the node and its parents

Note that the set of nodes returned may be empty if no path within the ArcGraphPart is outgoing from the given node.

Parameters

id	the node which is the tail of a directed path with the returned nodes

Definition at line 61 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                     {
    checkParents__(id);
    NodeSet res{id};
    return res + parents(id);
  }

Here is the call graph for this function:

family() [2/2]

INLINE NodeSet gum::ArcGraphPart::family ( const NodeSet &  ids ) const

inherited

returns the set of family nodes of a set of nodes

Definition at line 84 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                              {
    NodeSet res;
    for (const auto node: ids)
      res += family(node);
    return res;
  }

Here is the call graph for this function:

frequency()

template<typename GUM_SCALAR >

INLINE double gum::prm::gspan::DFSTree< GUM_SCALAR >::frequency

(

const Pattern &

p

)

const

Returns the frequency of p respecting it's maximal independent set.

Parameters

p	The pattern

Definition at line 519 of file DFSTree_tpl.h.

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

                                                                           {
        return (double)data__[const_cast< Pattern* >(&p)]->max_indep_set.size();
      }

Here is the call graph for this function:

graph()

template<typename GUM_SCALAR >

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

(

)

const

Returns the list of root patterns in this DFSTree.

Definition at line 506 of file DFSTree_tpl.h.

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

                                                      {
        return *graph__;
      }

Here is the call graph for this function:

growPattern()

template<typename GUM_SCALAR >

Pattern & gum::prm::gspan::DFSTree< GUM_SCALAR >::growPattern	(	Pattern &	p,
		EdgeGrowth< GUM_SCALAR > &	edge_growth,
		Size	min_freq
	)

Add a one edge growth of p as one of its child.

The child is inserted lexicographically among the children of p. However if the child is found to be not minimal an OperationNotAllowed is raised.

Parameters

p	The Pattern from which a one edge growth is spawned.
edge_growth	The data about the edge growth of p.
min_freq	minimum number of occurrence to be used as a pattern

Exceptions

FatalError	Raised if the grow is an illegal backedge growth.
OperationNotAllowed	Raised if the grow is found to be not minimal.

Definition at line 233 of file DFSTree_tpl.h.

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

                                                                                {
        Pattern* child = new Pattern(p);

        try {
          checkGrowth__(p, child, edge_growth);
        } catch (OperationNotAllowed&) {
          delete child;
          throw;
        }

        // Now we need to build the pattern data about child
        DFSTree< GUM_SCALAR >::PatternData* data
           = new DFSTree< GUM_SCALAR >::PatternData(child);
        std::vector< NodeId >                                    degree_list;
        NodeProperty< Sequence< PRMInstance< GUM_SCALAR >* >* >& p_iso_map
           = data__[&p]->iso_map;
        typename NodeProperty<
           std::pair< PRMInstance< GUM_SCALAR >*,
                      PRMInstance< GUM_SCALAR >* > >::iterator_safe match;
        // Using p information to build child's isomorphism graph
        NodeId id = 0;

        for (const auto& elt: p_iso_map) {
          auto match = edge_growth.matches.begin();

          for (; match != edge_growth.matches.end(); ++match) {
            // Adding the isomorphism in the iso_graph and building the iso_map.
            if (child->code().codes.back()->isForward()) {
              if (elt.second->exists(match.val().first)
                  && !(elt.second->exists(match.val().second))) {
                // Let's see if the new match is already matched
                Sequence< PRMInstance< GUM_SCALAR >* >* new_seq
                   = new Sequence< PRMInstance< GUM_SCALAR >* >(*elt.second);
                new_seq->insert(match.val().second);

                if (is_new_seq__(*new_seq, data->iso_map)) {
                  id = data->iso_graph.addNode();
                  data->iso_map.insert(id, new_seq);
                } else {
                  delete new_seq;
                }

                break;
              }
            } else {
              if (elt.second->exists(match.val().first)
                  && elt.second->exists(match.val().second)) {
                Sequence< PRMInstance< GUM_SCALAR >* >* new_seq
                   = new Sequence< PRMInstance< GUM_SCALAR >* >(*elt.second);

                if (is_new_seq__(*new_seq, data->iso_map)) {
                  id = data->iso_graph.addNode();
                  data->iso_map.insert(id, new_seq);
                } else {
                  delete new_seq;
                }

                break;
              }
            }
          }

          if (match != edge_growth.matches.end()) {
            // Adding edges in the iso_graph
            for (const auto node: data->iso_graph.nodes())
              if (node != id)
                for (const auto m: *data->iso_map[id])
                  if (data->iso_map[node]->exists(m)) {
                    data->iso_graph.addEdge(node, id);
                    break;
                  }

            degree_list.push_back(id);
            edge_growth.matches.erase(match.key());
          }
        }

        if (data->iso_graph.size() < min_freq) {
          delete data;
          delete child;
          GUM_ERROR(OperationNotAllowed, "child is not frequent enough");
        }

        // Now we can compute the maximal independent set of child
        DFSTree< GUM_SCALAR >::NeighborDegreeSort my_operator(data->iso_graph);
        std::sort(degree_list.begin(), degree_list.end(), my_operator);
        Set< NodeId > removed;

        for (const auto node: degree_list) {
          if (!removed.exists(node)) {
            removed.insert(node);

            for (const auto neighbor: data->iso_graph.neighbours(node))
              removed.insert(neighbor);

            data->max_indep_set.insert(node);
          }
        }

        data__.insert(child, data);

        if (!strategy__->accept_growth(&p, child, edge_growth)) {
          data__.erase(child);
          delete data;
          delete child;
          GUM_ERROR(OperationNotAllowed, "child is not frequent enough");
        }

        addChild__(p, child, edge_growth);
        return *child;
      }

Here is the call graph for this function:

hasDirectedPath()

bool gum::DiGraph::hasDirectedPath ( const NodeId  from, const NodeId  to  )

inherited

checks whether there exists a directed path from from to to

If from==to, this function checks if a directed cycle containing from exists.

Parameters

from
to

Returns

true if a directed path exists

Definition at line 136 of file diGraph.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                                  {
    if (!exists(from)) return false;

    // not recursive version => use a FIFO for simulating the recursion
    List< NodeId > nodeFIFO;
    nodeFIFO.pushBack(from);

    NodeSet marked;
    marked.insert(from);

    NodeId new_one;

    while (!nodeFIFO.empty()) {
      new_one = nodeFIFO.front();
      // std::cout<<new_one<<std::endl;
      nodeFIFO.popFront();

      for (const auto chi: children(new_one)) {
        if (chi == to) return true;

        if (!marked.contains(chi)) {
          nodeFIFO.pushBack(chi);
          marked.insert(chi);
        }
      }
    }

    return false;
  }

Here is the call graph for this function:

initialiaze_root__()

template<typename GUM_SCALAR >

void gum::prm::gspan::DFSTree< GUM_SCALAR >::initialiaze_root__ ( Pattern *  p, Sequence< EdgeData< GUM_SCALAR > * > &  seq  )

private

This initialize the DSFTree with a new root.

Parameters

p	A Pattern.
seq	A sequence of EdgeData<GUM_SCALAR>.

Definition at line 92 of file DFSTree_tpl.h.

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

                                                        {
        DFSTree< GUM_SCALAR >::PatternData* data = data__[p];
        std::vector< NodeId >               degree_list;

        for (auto iter = edge_seq.begin(); iter != edge_seq.end(); ++iter) {
          const auto&                             edge = *iter;
          Sequence< PRMInstance< GUM_SCALAR >* >* seq
             = new Sequence< PRMInstance< GUM_SCALAR >* >();

          // Creating the multiset of instances matching p
          bool u_first = (edge->l_u->id < edge->l_v->id);
          seq->insert((u_first) ? edge->u : edge->v);
          seq->insert((!u_first) ? edge->u : edge->v);

          NodeId an_id = data->iso_graph.addNode();
          data->iso_map.insert(an_id, seq);
          degree_list.push_back(an_id);

          // Adding edges between two isomorphisms of p sharing at least one
          // instance
          for (const auto& elt: data->iso_map)
            if (elt.first != an_id)
              for (auto iter = elt.second->begin(); iter != elt.second->end();
                   ++iter)
                if (seq->exists(*iter)) {
                  data->iso_graph.addEdge(an_id, elt.first);
                  break;
                }
        }

        // Computing p->max_indep_set using a greedy algorithm
        DFSTree< GUM_SCALAR >::NeighborDegreeSort my_operator(data->iso_graph);
        std::sort(degree_list.begin(), degree_list.end(), my_operator);
        Set< NodeId > removed;

        for (const auto node: degree_list) {
          if (!removed.exists(node)) {
            removed.insert(node);

            for (const auto neighbor: data->iso_graph.neighbours(node))
              removed.insert(neighbor);

            data->max_indep_set.insert(node);
          }
        }
      }

Here is the call graph for this function:

is_new_seq__()

template<typename GUM_SCALAR >

bool gum::prm::gspan::DFSTree< GUM_SCALAR >::is_new_seq__ ( Sequence< PRMInstance< GUM_SCALAR > * > &  seq, NodeProperty< Sequence< PRMInstance< GUM_SCALAR > * > * > &  iso_map  )

private

Check if an instance match is redundant.

Definition at line 142 of file DFSTree_tpl.h.

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

                                                                           {
        for (const auto& elt: iso_map) {
          bool found = false;

          for (const auto& inst: seq)
            if (!(elt.second->exists(inst))) {
              found = true;
              break;
            }

          if (!found) { return false; }
        }

        return true;
      }

Here is the call graph for this function:

iso_graph()

template<typename GUM_SCALAR >

INLINE UndiGraph & gum::prm::gspan::DFSTree< GUM_SCALAR >::iso_graph

(

const Pattern &

p

)

Returns the isomorphism graph of p in the interface graph.

The isomorphism graph is a undirected graph in which each node represents a set of PRMInstance<GUM_SCALAR> matching p in the interface graph.

If there exists an edge between two nodes in the isomorphism graph, then the two respective set of instances are not disjoint.

Parameters

p	The pattern for which we want the isomorphism graph.

Returns

The isomorphism graph of p.

Exceptions

NotFound

Raised if p is not a node in this DFSTree.

Definition at line 472 of file DFSTree_tpl.h.

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

                                                                         {
        try {
          return data__[const_cast< Pattern* >(&p)]->iso_graph;
        } catch (NotFound&) {
          GUM_ERROR(NotFound, "pattern not found in this DFSTree");
        }
      }

Here is the call graph for this function:

iso_map()

template<typename GUM_SCALAR >

INLINE Sequence< PRMInstance< GUM_SCALAR > *> & gum::prm::gspan::DFSTree< GUM_SCALAR >::iso_map	(	const Pattern &	p,
		NodeId	node
	)

Given a pattern and a node in its isomorphism graph, this methods returns the sequence of instance matching p in the interface graph.

The sequence of instances respect DSF subscripting. Each node in the pattern's graph have a DSF subscript from 1 to n, where n is the number of nodes in the pattern's graph.

If for a given match you want the k-th instance repecting p's DFS subscripting, then it will be the (k - 1)th element in the sequence.

Parameters

p	The pattern for which we want a match in the interface graph.
node	The node in p isomorphism graph for which we want the matching set if instances.

Returns

Returns the sequence of instances matching p and node.

Exceptions

NotFound

Raised if p or node does not exists.

Definition at line 482 of file DFSTree_tpl.h.

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

                                                                         {
        try {
          return *(data__[const_cast< Pattern* >(&p)]->iso_map[node]);
        } catch (NotFound&) {
          if (data__.exists(const_cast< Pattern* >(&p))) {
            GUM_ERROR(NotFound, "node not found in Pattern's isomorphism graph");
          } else {
            GUM_ERROR(NotFound, "pattern not found in this DFSTree");
          }
        }
      }

Here is the call graph for this function:

listMapArcs()

template<typename VAL >

List< VAL > gum::ArcGraphPart::listMapArcs ( VAL(*)(const Arc &)  f ) const

inherited

a method to create a list of VAL from a set of arcs (using for every arc, say x, the VAL f(x))

Parameters

f	a function assigning a VAL to any arc

listMapNodes()

template<typename VAL >

List< VAL > gum::NodeGraphPart::listMapNodes ( VAL(*)(const NodeId &)  f ) const

inherited

a method to create a list of VAL from a set of nodes (using for every nodee, say x, the VAL f(x))

Parameters

f	a function assigning a VAL to any node

max_indep_set()

template<typename GUM_SCALAR >

INLINE Set< NodeId > & gum::prm::gspan::DFSTree< GUM_SCALAR >::max_indep_set

(

const Pattern &

p

)

Returns the maximal independent set of p isomorphism graph.

Parameters

p	The pattern for which we want its maximal independent set.

Exceptions

NotFound

Raised if p is not a node in this DFSTree.

Definition at line 496 of file DFSTree_tpl.h.

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

                                                                  {
        try {
          return data__[const_cast< Pattern* >(&p)]->max_indep_set;
        } catch (NotFound&) {
          GUM_ERROR(NotFound, "pattern not found in this DFSTree");
        }
      }

Here is the call graph for this function:

nextNodeId()

INLINE NodeId gum::NodeGraphPart::nextNodeId ( ) const

inherited

returns a new node id, not yet used by any node

Warning

a code like

id=nextNodeId();addNode(id); 

is basically not thread safe !!

Returns

a node id not yet used by any node within the NodeGraphPart

Definition at line 225 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                {
    NodeId next = 0;

    // return the first hole if holes exist
    if (holes__ && (!holes__->empty()))
      next = *(holes__->begin());
    else   // in other case
      next = boundVal__;

    return next;
  }

Here is the call graph for this function:

nodes()

INLINE const NodeGraphPart & gum::NodeGraphPart::nodes ( ) const

inherited

return *this as a NodeGraphPart

Definition at line 372 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                         {
    return *(static_cast< const NodeGraphPart* >(this));
  }

Here is the call graph for this function:

nodesProperty() [1/2]

template<typename VAL >

NodeProperty< VAL > gum::NodeGraphPart::nodesProperty ( VAL(*)(const NodeId &)  f, Size  size = 0  ) const

inherited

a method to create a HashTable with key:NodeId and value:VAL

VAL are computed from the nodes using for all node x, VAL f(x). This method is a wrapper of the same method in HashTable.

See also

HashTable::map.

Parameters

f	a function assigning a VAL to any node
size	an optional parameter enabling to fine-tune the returned Property. Roughly speaking, it is a good practice to have a size equal to half the number of nodes. If you do not specify this parameter, the method will assign it for you.

nodesProperty() [2/2]

template<typename VAL >

NodeProperty< VAL > gum::NodeGraphPart::nodesProperty ( const VAL &  a, Size  size = 0  ) const

inherited

a method to create a hashMap with key:NodeId and value:VAL

for all nodes, the value stored is a. This method is a wrapper of the same method in HashTable.

See also

HashTable::map.

Parameters

a	the default value assigned to each edge in the returned Property
size	an optional parameter enabling to fine-tune the returned Property. Roughly speaking, it is a good practice to have a size equal to half the number of nodes. If you do not specify this parameter, the method will assign it for you.

operator!=() [1/3]

INLINE bool gum::ArcGraphPart::operator!= ( const ArcGraphPart &  p ) const

inherited

tests whether two ArcGraphParts contain different arcs

Parameters

p	the ArcGraphPart that we compare with this

Definition at line 186 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                  {
    return arcs__ != p.arcs__;
  }

Here is the call graph for this function:

operator!=() [2/3]

INLINE bool gum::DiGraph::operator!= ( const DiGraph &  g ) const

inherited

tests whether two DiGraphs are different

Parameters

g	the DiGraph with which "this" is compared

Definition at line 82 of file diGraph_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                        {
    return !operator==(p);
  }

Here is the call graph for this function:

operator!=() [3/3]

INLINE bool gum::NodeGraphPart::operator!= ( const NodeGraphPart &  p ) const

inherited

check whether two NodeGraphParts contain different nodes

Parameters

p	the NodeGraphPart to be compared with "this"

Definition at line 356 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                    {
    return !operator==(p);
  }

Here is the call graph for this function:

operator==() [1/3]

INLINE bool gum::ArcGraphPart::operator== ( const ArcGraphPart &  p ) const

inherited

tests whether two ArcGraphParts contain the same arcs

Parameters

p	the ArcGraphPart that we compare with this

Definition at line 182 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                  {
    return arcs__ == p.arcs__;
  }

Here is the call graph for this function:

operator==() [2/3]

INLINE bool gum::DiGraph::operator== ( const DiGraph &  g ) const

inherited

tests whether two DiGraphs are identical (same nodes, same arcs)

Parameters

g	the DiGraph with which "this" is compared

Definition at line 78 of file diGraph_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                        {
    return ArcGraphPart::operator==(p) && NodeGraphPart::operator==(p);
  }

Here is the call graph for this function:

operator==() [3/3]

INLINE bool gum::NodeGraphPart::operator== ( const NodeGraphPart &  p ) const

inherited

check whether two NodeGraphParts contain the same nodes

Parameters

p	the NodeGraphPart to be compared with "this"

Definition at line 342 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                    {
    if (boundVal__ != p.boundVal__) return false;

    if (holes__)
      if (p.holes__)
        return (*holes__ == *p.holes__);
      else
        return false;
    else if (p.holes__)
      return false;

    return true;
  }

Here is the call graph for this function:

parent() [1/2]

template<typename GUM_SCALAR >

INLINE Pattern & gum::prm::gspan::DFSTree< GUM_SCALAR >::parent

(

const Pattern &

p

)

Returns the parent of p in this DFSTree.

Definition at line 404 of file DFSTree_tpl.h.

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

                                                                    {
        try {
          return *(node_map__.second(
             *(DiGraph::parents(node_map__.first(const_cast< Pattern* >(&p)))
                  .begin())));
        } catch (NotFound&) {
          if (node_map__.existsSecond(const_cast< Pattern* >(&p))) {
            GUM_ERROR(NotFound, "the given pattern is a root node");
          } else {
            GUM_ERROR(NotFound, "pattern not found in this DFSTree");
          }
        }
      }

Here is the call graph for this function:

parent() [2/2]

template<typename GUM_SCALAR >

INLINE const Pattern & gum::prm::gspan::DFSTree< GUM_SCALAR >::parent

(

const Pattern &

p

)

const

Returns the parent of p in this DFSTree.

Definition at line 419 of file DFSTree_tpl.h.

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

                                                                                {
        try {
          return *(node_map__.second(
             *(DiGraph::parents(node_map__.first(const_cast< Pattern* >(&p)))
                  .begin())));
        } catch (NotFound&) {
          if (node_map__.existsSecond(const_cast< Pattern* >(&p))) {
            GUM_ERROR(NotFound, "the given pattern is a root node");
          } else {
            GUM_ERROR(NotFound, "pattern not found in this DFSTree");
          }
        }
      }

Here is the call graph for this function:

parents() [1/2]

INLINE const NodeSet & gum::ArcGraphPart::parents ( NodeId  id ) const

inherited

returns the set of nodes with arc ingoing to a given node

Note that the set of arcs returned may be empty if no arc within the ArcGraphPart is ingoing into the given node.

Parameters

id	the node toward which the arcs returned are pointing

Definition at line 56 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                             {
    checkParents__(id);
    return *(parents__[id]);
  }

Here is the call graph for this function:

parents() [2/2]

INLINE NodeSet gum::ArcGraphPart::parents ( const NodeSet &  ids ) const

inherited

returns the set of parents of a set of nodes

Definition at line 76 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                               {
    NodeSet res;
    for (const auto node: ids)
      res += parents(node);
    return res;
  }

Here is the call graph for this function:

pattern() [1/2]

template<typename GUM_SCALAR >

INLINE Pattern & gum::prm::gspan::DFSTree< GUM_SCALAR >::pattern

(

NodeId

id

)

Returns the pattern represented by id in this DFSTree.

Definition at line 454 of file DFSTree_tpl.h.

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

                                                              {
        try {
          return *(node_map__.second(id));
        } catch (NotFound&) {
          GUM_ERROR(NotFound, "no pattern matching the given id");
        }
      }

Here is the call graph for this function:

pattern() [2/2]

template<typename GUM_SCALAR >

INLINE const Pattern & gum::prm::gspan::DFSTree< GUM_SCALAR >::pattern

(

NodeId

id

)

const

Returns the pattern represented by id in this DFSTree.

Definition at line 463 of file DFSTree_tpl.h.

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

                                                                          {
        try {
          return *(node_map__.second(id));
        } catch (NotFound&) {
          GUM_ERROR(NotFound, "no pattern matching the given id");
        }
      }

Here is the call graph for this function:

populateNodes()

void gum::NodeGraphPart::populateNodes ( const NodeGraphPart &  s )

inherited

populateNodes clears *this and fills it with the same nodes as "s"

populateNodes should basically be the preferred way to insert nodes with IDs not selected by the internal idFactory.

Parameters

s	the NodeGraphPart to be copied

Definition at line 63 of file nodeGraphPart.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                          {
    clear();   // "virtual" flush of the nodes set
    holes_size__          = s.holes_size__;
    holes_resize_policy__ = s.holes_resize_policy__;

    if (s.holes__) holes__ = new NodeSet(*s.holes__);

    boundVal__ = s.boundVal__;

    updateEndIteratorSafe__();
  }

Here is the call graph for this function:

populateNodesFromProperty()

template<typename T >

void gum::NodeGraphPart::populateNodesFromProperty ( const NodeProperty< T > &  h )

inherited

populateNodesFromProperty clears *this and fills it with the keys of "h"

populateNodes should basically be the preferred way to insert nodes with IDs not selected by the internal idFactory.

roots() [1/2]

template<typename GUM_SCALAR >

INLINE std::list< NodeId > & gum::prm::gspan::DFSTree< GUM_SCALAR >::roots

(

)

Returns the list of root patterns in this DFSTree.

Definition at line 394 of file DFSTree_tpl.h.

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

                                                             {
        return roots__;
      }

Here is the call graph for this function:

roots() [2/2]

template<typename GUM_SCALAR >

INLINE const std::list< NodeId > & gum::prm::gspan::DFSTree< GUM_SCALAR >::roots

(

)

const

Returns the list of root patterns in this DFSTree.

Definition at line 399 of file DFSTree_tpl.h.

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

                                                                         {
        return roots__;
      }

Here is the call graph for this function:

size()

INLINE Size gum::NodeGraphPart::size ( ) const

inherited

alias for sizeNodes

Definition at line 283 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return sizeNodes(); }

Here is the call graph for this function:

sizeArcs()

INLINE Size gum::ArcGraphPart::sizeArcs ( ) const

inherited

indicates the number of arcs stored within the ArcGraphPart

Definition at line 36 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return arcs__.size(); }

Here is the call graph for this function:

sizeNodes()

INLINE Size gum::NodeGraphPart::sizeNodes ( ) const

inherited

returns the number of nodes in the NodeGraphPart

Definition at line 279 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                             {
    return (holes__) ? (boundVal__ - holes__->size()) : boundVal__;
  }

Here is the call graph for this function:

strategy() [1/2]

template<typename GUM_SCALAR >

INLINE SearchStrategy< GUM_SCALAR > & gum::prm::gspan::DFSTree< GUM_SCALAR >::strategy

(

)

strategy getter

Definition at line 536 of file DFSTree_tpl.h.

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

                                                                           {
        return *strategy__;
      }

Here is the call graph for this function:

strategy() [2/2]

template<typename GUM_SCALAR >

INLINE const SearchStrategy< GUM_SCALAR > & gum::prm::gspan::DFSTree< GUM_SCALAR >::strategy

(

)

const

strategy getter

Definition at line 542 of file DFSTree_tpl.h.

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

                                                         {
        return *strategy__;
      }

Here is the call graph for this function:

test_equality__()

template<typename GUM_SCALAR >

bool gum::prm::gspan::DFSTree< GUM_SCALAR >::test_equality__ ( HashTable< PRMClassElement< GUM_SCALAR > *, Size > &  x, HashTable< PRMClassElement< GUM_SCALAR > *, Size > &  y  )

private

Definition at line 348 of file DFSTree_tpl.h.

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

                                                               {
        try {
          for (const auto& elt: x)
            if (y[elt.first] != elt.second) return false;
        } catch (NotFound&) { return false; }

        return true;
      }

Here is the call graph for this function:

toDot()

std::string gum::DiGraph::toDot ( ) const

virtualinherited

to friendly display the content of the graph in the DOT syntax

Parameters

name	The graph name in the dot syntax. Default is G.

Returns

Returns a string describing the graph in the dot syntax

Reimplemented in gum::MixedGraph.

Definition at line 67 of file diGraph.cpp.

References gum::Set< Key, Alloc >::emplace().

                                 {
    std::stringstream strBuff;
    std::string       tab = "     ";
    strBuff << "digraph {" << std::endl;

    for (const auto node: nodes())
      strBuff << tab << node << ";" << std::endl;

    strBuff << std::endl;

    for (const auto& arc: arcs())
      strBuff << tab << arc.tail() << " -> " << arc.head() << ";" << std::endl;

    strBuff << "}" << std::endl << std::endl;
    return strBuff.str();
  }

Here is the call graph for this function:

topologicalOrder()

const Sequence< NodeId > & gum::DiGraph::topologicalOrder ( bool  clear = true ) const

inherited

The topological order stays the same as long as no variable or arcs are added or erased src the topology.

Parameters

clear

If false returns the previously created topology.

Exceptions

InvalidDirectedCycle

Raised if this DiGraph contains cycles.

Definition at line 90 of file diGraph.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                                      {
    if (clear
        || (mutableTopologicalOrder__
            == nullptr)) {   // we have to call topologicalOrder_
      if (mutableTopologicalOrder__ == nullptr) {
        mutableTopologicalOrder__ = new Sequence< NodeId >();
      } else {
        // clear is True
        mutableTopologicalOrder__->clear();
      }

      topologicalOrder__();
    }

    return *mutableTopologicalOrder__;
  }

Here is the call graph for this function:

toString()

std::string gum::DiGraph::toString ( ) const

virtualinherited

to friendly display the content of the graph

Reimplemented from gum::NodeGraphPart.

Reimplemented in gum::MixedGraph.

Definition at line 60 of file diGraph.cpp.

References gum::Set< Key, Alloc >::emplace().

                                    {
    std::string s = NodeGraphPart::toString();
    s += " , ";
    s += ArcGraphPart::toString();
    return s;
  }

Here is the call graph for this function:

unvirtualizedEraseChildren()

INLINE void gum::ArcGraphPart::unvirtualizedEraseChildren ( NodeId  id )

inherited

same function as eraseChildren but without any virtual call to an erase

Parameters

id	the node whose outgoing arcs will be removed

Definition at line 170 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                {
    if (children__.exists(id)) {
      NodeSet& children = *(children__[id]);

      for (auto iter = children.beginSafe();   // safe iterator needed here
           iter != children.endSafe();
           ++iter) {
        ArcGraphPart::eraseArc(Arc(id, *iter));
      }
    }
  }

Here is the call graph for this function:

unvirtualizedEraseParents()

INLINE void gum::ArcGraphPart::unvirtualizedEraseParents ( NodeId  id )

inherited

same function as eraseParents but without any virtual call to an erase

Parameters

id	the node whose ingoing arcs will be removed

Definition at line 158 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                               {
    if (parents__.exists(id)) {
      NodeSet& parents = *(parents__[id]);

      for (auto iter = parents.beginSafe();   // safe iterator needed here
           iter != parents.endSafe();
           ++iter) {
        ArcGraphPart::eraseArc(Arc(*iter, id));
      }
    }
  }

Here is the call graph for this function:

unvirtualizedEraseSetOfArcs_()

INLINE void gum::ArcGraphPart::unvirtualizedEraseSetOfArcs_ ( const ArcSet &  set )

protectedinherited

similar to eraseSetOfArcs_ except that it is unvirtualized

Warning

this function uses ArcGraphPart::eraseArc, hence, as compared with eraseSetOfArcs_, it removes the arcs without calling a virtual eraseArc

Definition at line 153 of file arcGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                          {
    for (const auto& arc: set)
      ArcGraphPart::eraseArc(arc);
  }

Here is the call graph for this function:

Member Data Documentation

data__

template<typename GUM_SCALAR >

HashTable< Pattern*, PatternData* > gum::prm::gspan::DFSTree< GUM_SCALAR >::data__

private

Data about patterns in this DFSTree.

Definition at line 273 of file DFSTree.h.

graph__

template<typename GUM_SCALAR >

const InterfaceGraph< GUM_SCALAR >* gum::prm::gspan::DFSTree< GUM_SCALAR >::graph__

private

The interface graph on which this DFSTree applies.

Definition at line 263 of file DFSTree.h.

node_map__

template<typename GUM_SCALAR >

Bijection< NodeId, Pattern* > gum::prm::gspan::DFSTree< GUM_SCALAR >::node_map__

private

The mapping between nodes in this DFSTree and the patterns they represents.

Definition at line 270 of file DFSTree.h.

onArcAdded

Signaler2< NodeId, NodeId > gum::ArcGraphPart::onArcAdded

inherited

Definition at line 82 of file arcGraphPart.h.

onArcDeleted

Signaler2< NodeId, NodeId > gum::ArcGraphPart::onArcDeleted

inherited

Definition at line 83 of file arcGraphPart.h.

onNodeAdded

Signaler1< NodeId > gum::NodeGraphPart::onNodeAdded

inherited

Definition at line 271 of file nodeGraphPart.h.

onNodeDeleted

Signaler1< NodeId > gum::NodeGraphPart::onNodeDeleted

inherited

Definition at line 272 of file nodeGraphPart.h.

roots__

template<typename GUM_SCALAR >

std::list< NodeId > gum::prm::gspan::DFSTree< GUM_SCALAR >::roots__

private

The list of root patterns in this DFSTree.

Definition at line 266 of file DFSTree.h.

strategy__

template<typename GUM_SCALAR >

SearchStrategy< GUM_SCALAR >* gum::prm::gspan::DFSTree< GUM_SCALAR >::strategy__

private

The strategy used to prune the search tree.

Definition at line 276 of file DFSTree.h.

---

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

• agrum/PRM/gspan/DFSTree.h
• agrum/PRM/gspan/DFSTree_tpl.h