This contains all the information we want for a node in a DFSTree. More...

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

Inheritance diagram for gum::prm::gspan::Pattern:

Collaboration diagram for gum::prm::gspan::Pattern:

Public Member Functions
Constructor and destructor.
	Pattern ()
	Default constructor.
	Pattern (const Pattern &source)
	Copy constructor.
	~Pattern () override
	Destructor.
Graphical getters and setters.
NodeId	addNodeWithLabel (LabelData &l)
	Insert a node with the given LabelData.
LabelData &	label (NodeId node)
	Returns the LabelData assigned to node.
const LabelData &	label (NodeId node) const
	Returns the LabelData assigned to node.
LabelData &	label (NodeId i, NodeId j)
	Returns the LabelData assigned to arc.
const LabelData &	label (NodeId i, NodeId j) const
	Returns the LabelData assigned to arc.
LabelData &	label (const Arc &arc)
	Returns the LabelData assigned to arc.
const LabelData &	label (const Arc &arc) const
	Returns the LabelData assigned to arc.
LabelData &	lastAdded ()
	Insert a node with the given LabelData.
const LabelData &	lastAdded () const
	Insert a node with the given LabelData.
void	addArc (NodeId i, NodeId j, LabelData &l)
	Add an arc to this Pattern.
bool	exists (NodeId id) const
	Returns true if id is a node in this Pattern.
bool	exists (NodeId tail, NodeId head) const
	Returns true if (tail, head) is an arc in this Pattern.
Size	size () const
	Returns the number of nodes in this Pattern.
Size	sizeArcs () const
	Returns the number of arcs in this Pattern.
void	rightmostPath (std::list< NodeId > &r_path) const
	Fill r_path with the rightmost path of this Pattern. The list is supposed empty.
std::string	toDot (size_t name) const
	Print the pattern in the DOT syntax.
Access to topology
const NodeGraphPart &	nodes () const
const ArcSet &	arcs () const
DFSCode related methods.
DFSCode &	code ()
	Returns the DFSCode of this Pattern.
const DFSCode &	code () const
	Returns the DFSCode of this Pattern.
EdgeCode &	edgeCode (NodeId tail, NodeId head)
	Returns the EdgeCode of an edge of this Pattern.
EdgeCode &	edgeCode (const Arc &arc)
	Returns the EdgeCode of an edge of this Pattern.
const EdgeCode &	edgeCode (NodeId tail, NodeId head) const
	Returns the EdgeCode of an edge of this Pattern.
const EdgeCode &	edgeCode (const Arc &arc) const
	Returns the EdgeCode of an edge of this Pattern.
void	pop_back ()
	Remove the last EdgeCode of this pattern.
void	remove (NodeId node)
	Remove a node if it has no neighbors, raise an OperationNotAllowed otherwise.
bool	isMinimal ()
	Returns the DFSCode of this Pattern.

Private Types
using	ArcIterator = ArcSetIterator
using	NodeIterator = NodeGraphPartIterator
using	NodeConstIterator = NodeGraphPartIterator
using	NodeIteratorSafe = NodeGraphPartIteratorSafe
using	NodeConstIteratorSafe = NodeGraphPartIteratorSafe

using	node_iterator = NodeGraphPartIterator
	types for STL compliance
using	node_const_iterator = NodeGraphPartIterator
	types for STL compliance
using	node_iterator_safe = NodeGraphPartIteratorSafe
	types for STL compliance
using	node_const_iterator_safe = NodeGraphPartIteratorSafe
	types for STL compliance

Private Member Functions

bool _expandCodeIsMinimal_ (NodeId u, NodeId v)

Returns true if the expand code by adding and edge betwenne u and v is minimal with respect to code.

bool _rec_ (Pattern &p, Bijection< NodeId, NodeId > &node_map, NodeId u, NodeId v)

Recurisve method used by expandCodeIsMinimal.

bool _not_rec_ (Pattern &p, Bijection< NodeId, NodeId > &node_map, NodeId u, NodeId v)

A non recursive bugged version of rec.

void addArc (const NodeId tail, const NodeId head) override

insert a new arc into the directed graph

virtual std::string toDot () const

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

bool hasDirectedPath (NodeId from, NodeId to) const

checks whether there exists a directed path from from to to

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

returns a directed path from node1 to node2, or std::nullopt if none

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

returns a shortest path from node1 to node2 ignoring arc orientation, or std::nullopt if none

NodeSet ancestors (NodeId id) const

returns the set of all ancestors of id (nodes from which id is reachable)

NodeSet descendants (NodeId id) const

returns the set of all descendants of id (nodes reachable from id)

NodeSet family (NodeId id) const

returns { id } ∪ parents(id)

NodeSet family (const NodeSet &ids) const

returns the union of families of all nodes in ids

NodeProperty< NodeId > connectedComponents () const

returns a property {node:id of weakly connected component}

void eraseSetOfArcs_ (const ArcSet &set)

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

void unvirtualizedEraseSetOfArcs_ (const ArcSet &set)

similar to eraseSetOfArcs_ except that it is unvirtualized

void _checkParents_ (NodeId id)

when the ArcGraphPart contains no arc ingoing into a given node, this function adds an empty set entry to parents[id]

void _checkChildren_ (NodeId id)

when the ArcGraphPart contains no arc outgoing from a given node, this function adds an empty set entry to children[id]

Operators

bool operator== (const DiGraph &g) const

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

Operators

bool operator== (const ArcGraphPart &p) const

tests whether two ArcGraphParts contain the same arcs

Accessors/Modifiers

tests whether two DiGraphs are different

Parameters

g	the DiGraph with which "this" is compared

void eraseNode (const NodeId id) override

remove a node and its adjacent arcs from the graph

void clear () override

removes all the nodes and arcs from the graph

std::string toString () const override

to friendly display the content of the graph

Sequence< NodeId > topologicalOrder () const

Build and return a topological order.

Accessors/Modifiers

virtual void eraseArc (const Arc &arc)

removes an arc from the ArcGraphPart

bool existsArc (const Arc &arc) const

indicates whether a given arc exists

bool existsArc (NodeId tail, NodeId head) const

indicates whether a given arc exists

bool emptyArcs () const

indicates wether the ArcGraphPart contains any arc

void clearArcs ()

removes all the arcs from the ArcGraphPart

const NodeSet & parents (NodeId id) const

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

NodeSet parents (const NodeSet &ids) const

returns the set of parents of a set of nodes

NodeSet children (const NodeSet &ids) const

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

const NodeSet & children (NodeId id) const

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

void eraseParents (NodeId id)

erase all the parents of a given node

void unvirtualizedEraseParents (NodeId id)

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

void eraseChildren (NodeId id)

removes all the children of a given node

void unvirtualizedEraseChildren (NodeId id)

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

template<typename VAL>

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

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

template<typename VAL>

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

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

template<typename VAL>

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

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

Operators

bool operator== (const NodeGraphPart &p) const

check whether two NodeGraphParts contain the same nodes

Accessors/Modifiers

void populateNodes (const NodeGraphPart &s)

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

template<typename T>

void populateNodesFromProperty (const NodeProperty< T > &h)

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

NodeId nextNodeId () const

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

virtual NodeId addNode ()

insert a new node and return its id

std::vector< NodeId > addNodes (Size n)

insert n nodes

virtual void addNodeWithId (const NodeId id)

try to insert a node with the given id

bool existsNode (const NodeId id) const

returns true iff the NodeGraphPart contains the given nodeId

bool emptyNodes () const

indicates whether there exists nodes in the NodeGraphPart

bool empty () const

alias for emptyNodes

virtual void clearNodes ()

remove all the nodes from the NodeGraphPart

Size sizeNodes () const

returns the number of nodes in the NodeGraphPart

NodeId bound () const

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

NodeSet asNodeSet () const

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

node_iterator_safe beginSafe () const

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

const node_iterator_safe & endSafe () const noexcept

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

node_iterator begin () const noexcept

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

const node_iterator & end () const noexcept

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

std::string nameFromId (NodeId id) const

returns the name of node id, or "<id>" if no name is set

std::optional< NodeId > idFromName (const std::string &name) const

returns the id of the node with the given name, or std::nullopt

void setName (NodeId id, const std::string &name)

sets the name of node id

bool hasName (NodeId id) const

returns true iff node id has an explicit name

std::string dotNodeLabel (NodeId id) const

returns " [label=\"...\"]" with DOT-escaped name, or "" if no name

template<typename VAL>

NodeProperty< VAL > nodesPropertyFromFunction (VAL(*f)(const NodeId &), Size size=0) const

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

template<typename VAL>

NodeProperty< VAL > nodesPropertyFromVal (const VAL &a, Size size=0) const

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

template<typename VAL>

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

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

Static Private Member Functions
Constructors / Destructors
static DiGraph	completeGraph (int n)
	Build a complete DiGraph with n nodes.

Private Attributes
DFSCode	_code_
	The DFSCode of this Pattern.
NodeProperty< LabelData * >	_node_map_
	Mapping between nodes in this Pattern and their respective LabelData.
ArcProperty< std::pair< LabelData , EdgeCode > >	_arc_map_
	Mapping between edges in this Pattern and their respective LabelData.
LabelData *	_last_ = nullptr
	The last LabelData added to this pattern.
Signaler< NodeId, NodeId >	onArcAdded
Signaler< NodeId, NodeId >	onArcDeleted
Set< Arc >	_arcs_
	the set of all the arcs contained within the ArcGraphPart
NodeProperty< NodeSet * >	_parents_
	for each arc, the sets of its parents
NodeProperty< NodeSet * >	_children_
	for each arc, the set of its children
Signaler< NodeId >	onNodeAdded
Signaler< NodeId >	onNodeDeleted

Detailed Description

This contains all the information we want for a node in a DFSTree.

Several rules are used regarding nodes in Pattern::graph. First nodes are added respecting a depth-first search, thus each node is labelled from 1 to n, where n is the number of nodes in Pattern::graph.

Given two nodes id i and j, if i < j then i was discovered before j in the depth first search.

To retrieve the depth first search tree from Pattern::graph simple consider only arcs (u, v) with u < v. The set of arcs { (u,v) | u < v} is called the forward edge set and the set of arcs { (u,v) | u > v} is called the backward edge set.

The orientation in Pattern::graph is only used to differentiate forward edges from backward edges.

Definition at line 90 of file pattern.h.

Member Typedef Documentation

◆ ArcIterator

using gum::ArcGraphPart::ArcIterator = ArcSetIterator

inherited

Definition at line 100 of file arcGraphPart.h.

◆ node_const_iterator

using gum::NodeGraphPart::node_const_iterator = NodeGraphPartIterator

inherited

types for STL compliance

Definition at line 268 of file nodeGraphPart.h.

◆ node_const_iterator_safe

using gum::NodeGraphPart::node_const_iterator_safe = NodeGraphPartIteratorSafe

inherited

types for STL compliance

Definition at line 270 of file nodeGraphPart.h.

◆ node_iterator

using gum::NodeGraphPart::node_iterator = NodeGraphPartIterator

inherited

types for STL compliance

Definition at line 267 of file nodeGraphPart.h.

◆ node_iterator_safe

using gum::NodeGraphPart::node_iterator_safe = NodeGraphPartIteratorSafe

inherited

types for STL compliance

Definition at line 269 of file nodeGraphPart.h.

◆ NodeConstIterator

using gum::NodeGraphPart::NodeConstIterator = NodeGraphPartIterator

inherited

Definition at line 277 of file nodeGraphPart.h.

◆ NodeConstIteratorSafe

using gum::NodeGraphPart::NodeConstIteratorSafe = NodeGraphPartIteratorSafe

inherited

Definition at line 279 of file nodeGraphPart.h.

◆ NodeIterator

using gum::NodeGraphPart::NodeIterator = NodeGraphPartIterator

inherited

Definition at line 276 of file nodeGraphPart.h.

◆ NodeIteratorSafe

using gum::NodeGraphPart::NodeIteratorSafe = NodeGraphPartIteratorSafe

inherited

Definition at line 278 of file nodeGraphPart.h.

Constructor & Destructor Documentation

◆ Pattern() [1/2]

INLINE gum::prm::gspan::Pattern::Pattern ( )

Default constructor.

Definition at line 57 of file pattern_inl.h.

                       : DiGraph(), _last_(0) {
        GUM_CONSTRUCTOR(Pattern);
        ;
      }

References gum::DiGraph::DiGraph(), Pattern(), and _last_.

Referenced by Pattern(), Pattern(), ~Pattern(), _expandCodeIsMinimal_(), _not_rec_(), and _rec_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Pattern() [2/2]

gum::prm::gspan::Pattern::Pattern ( const Pattern & source )

Copy constructor.

Definition at line 57 of file pattern.cpp.

                                        : DiGraph() {
    GUM_CONS_CPY(Pattern);
    NodeProperty< NodeId > node_map;
 
    for (NodeId node = 1; node <= source.size(); ++node) {
      node_map.insert(node, addNodeWithLabel(const_cast< LabelData& >(source.label(node))));
    }
 
    for (const auto& edge: source.code().codes)
      addArc(node_map[edge->i],
             node_map[edge->j],
             const_cast< LabelData& >(source.label(node_map[edge->i], node_map[edge->j])));
  }

References gum::DiGraph::DiGraph(), Pattern(), addArc(), addNodeWithLabel(), code(), gum::prm::gspan::DFSCode::codes, gum::HashTable< Key, Val >::insert(), label(), and size().

Here is the call graph for this function:

◆ ~Pattern()

INLINE gum::prm::gspan::Pattern::~Pattern ( )

override

Destructor.

Definition at line 63 of file pattern_inl.h.

                        {
        GUM_DESTRUCTOR(Pattern);
        ;
      }

References Pattern().

Here is the call graph for this function:

Member Function Documentation

◆ _checkChildren_()

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

privateinherited

when the ArcGraphPart contains no arc outgoing from a given node, this function adds an empty set entry to children[id]

Parameters

id	the node whose children[id] is checked

Definition at line 72 of file arcGraphPart_inl.h.

                                                     {
    if (!_children_.exists(id)) { _children_.insert(id, new NodeSet); }
  }

References _children_.

Referenced by addArc().

Here is the caller graph for this function:

◆ _checkParents_()

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

privateinherited

when the ArcGraphPart contains no arc ingoing into a given node, this function adds an empty set entry to parents[id]

Parameters

id	the node whose parents[id] is checked

Definition at line 68 of file arcGraphPart_inl.h.

                                                    {
    if (!_parents_.exists(id)) { _parents_.insert(id, new NodeSet); }
  }

References _parents_.

Referenced by addArc().

Here is the caller graph for this function:

◆ _expandCodeIsMinimal_()

bool gum::prm::gspan::Pattern::_expandCodeIsMinimal_	(	NodeId	u,
		NodeId	v )

private

Returns true if the expand code by adding and edge betwenne u and v is minimal with respect to code.

Parameters

u	A node in this Pattern.
v	A node in this Pattern.

Returns: true if the expand code by adding and edge betwenne u and v is minimal with respect to code.

Definition at line 111 of file pattern.cpp.

                                                        {
    Bijection< NodeId, NodeId > node_map;
    Pattern                     p;
    node_map.insert(u, p.addNodeWithLabel(label(u)));
    node_map.insert(v, p.addNodeWithLabel(label(v)));
 
    if (_arc_map_.exists(Arc(u, v))) {
      p.addArc(1, 2, label(u, v));
    } else {
      p.addArc(1, 2, label(v, u));
    }
 
    for (const auto nei: children(u))
      if (nei != v)
        if (_rec_(p, node_map, u, nei)) return true;
 
    for (const auto nei: parents(u))
      if (nei != v)
        if (_rec_(p, node_map, u, nei)) return true;
 
    for (const auto nei: children(v))
      if (nei != u)
        if (_rec_(p, node_map, v, nei)) return true;
 
    for (const auto nei: parents(v))
      if (nei != u)
        if (_rec_(p, node_map, v, nei)) return true;
 
    return false;
  }

References Pattern(), _arc_map_, _rec_(), addArc(), addNodeWithLabel(), gum::ArcGraphPart::children(), gum::BijectionImplementation< T1, T2, Gen >::insert(), label(), and gum::ArcGraphPart::parents().

Referenced by isMinimal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _not_rec_()

bool gum::prm::gspan::Pattern::_not_rec_	(	Pattern &	p,
		Bijection< NodeId, NodeId > &	node_map,
		NodeId	u,
		NodeId	v )

private

A non recursive bugged version of rec.

Definition at line 201 of file pattern.cpp.

                                                            {
    std::vector< std::pair< NodeId, NodeId > > stack;
    stack.emplace_back(a_u, a_v);
    NodeId u = 0;
    NodeId v = 0;
 
    while (!stack.empty()) {
      bool go = true;
      u       = stack.back().first;
      v       = stack.back().second;
      stack.pop_back();
 
      if ((u == 0) && (v == 0)) {
        p.pop_back();
      } else {
        if (node_map.existsFirst(v)) {
          if (node_map.second(u) < node_map.second(v)) {
            // Invalid forward edge
            go = false;
          } else if ((p.existsArc(node_map.second(u), node_map.second(v)))
                     || (p.existsArc(node_map.second(v), node_map.second(u)))) {
            // Duplicate arc !
            go = false;
          }
        } else {
          node_map.insert(v, p.addNodeWithLabel(label(v)));
        }
 
        if (go) {
          // Retrieving arc label data
          LabelData* data = 0;
 
          if (_arc_map_.exists(Arc(u, v))) data = &(label(u, v));
          else data = &(label(v, u));
 
          // Adding arc
          try {
            p.addArc(node_map.second(u), node_map.second(v), *data);
          } catch (OperationNotAllowed const&) {
            // Invalid neighbor
            if (node_map.second(u) < node_map.second(v)) {
              p.remove(node_map.second(v));
              node_map.eraseFirst(v);
            }
 
            go = false;
          }
 
          if (go) {
            // Check if this is minimal or if equal find another growth
            if (size_t depth = p.code().codes.size() - 1;
                *(p.code().codes.back()) < *(code().codes[depth])) {
              return true;
            } else if (*(p.code().codes.back()) == *(code().codes[depth])) {
              std::list< NodeId > r_path;
              p.rightmostPath(r_path);
              stack.emplace_back((NodeId)0, (NodeId)0);
 
              for (const auto node: r_path) {
                for (const auto nei: children(node)) {
                  stack.emplace_back(node_map.first(node), nei);
                }
 
                for (const auto nei: parents(node)) {
                  stack.emplace_back(node_map.first(node), nei);
                }
              }
            }
 
            if (p.code().codes.back()->isForward()) node_map.eraseFirst(v);
          }
        }
      }
    }
 
    return false;
  }

References Pattern(), _arc_map_, addArc(), addNodeWithLabel(), gum::ArcGraphPart::children(), code(), gum::prm::gspan::DFSCode::codes, gum::BijectionImplementation< T1, T2, Gen >::eraseFirst(), gum::ArcGraphPart::existsArc(), gum::BijectionImplementation< T1, T2, Gen >::existsFirst(), gum::BijectionImplementation< T1, T2, Gen >::first(), gum::BijectionImplementation< T1, T2, Gen >::insert(), label(), gum::ArcGraphPart::parents(), pop_back(), remove(), rightmostPath(), and gum::BijectionImplementation< T1, T2, Gen >::second().

Here is the call graph for this function:

◆ _rec_()

bool gum::prm::gspan::Pattern::_rec_	(	Pattern &	p,
		Bijection< NodeId, NodeId > &	node_map,
		NodeId	u,
		NodeId	v )

private

Recurisve method used by expandCodeIsMinimal.

Parameters

p	A Pattern.
node_map	A bijection.
u	A node in this Pattern.
v	A node in this Pattern.

Returns: true if the expansion is minimal.

Definition at line 142 of file pattern.cpp.

                                                                                           {
    if (node_map.existsFirst(v)) {
      if (node_map.second(u) < node_map.second(v)) {
        // Invalid forward edge
        return false;
      } else if ((p.existsArc(node_map.second(u), node_map.second(v)))
                 || (p.existsArc(node_map.second(v), node_map.second(u)))) {
        // Duplicate arc !
        return false;
      }
    } else {
      node_map.insert(v, p.addNodeWithLabel(label(v)));
    }
 
    // Retrieving arc label data
    LabelData* data = 0;
 
    if (_arc_map_.exists(Arc(u, v))) {
      data = &(label(u, v));
    } else {
      data = &(label(v, u));
    }
 
    // Adding arc
    try {
      p.addArc(node_map.second(u), node_map.second(v), *data);
    } catch (OperationNotAllowed const&) {
      // Invalid neighbor
      if (node_map.second(u) < node_map.second(v)) {
        p.remove(node_map.second(v));
        node_map.eraseFirst(v);
      }
 
      return false;
    }
 
    // Check if this is minimal or if equal find another growth
    if (size_t depth = p.code().codes.size() - 1;
        *(p.code().codes.back()) < *(code().codes[depth])) {
      return true;
    } else if (*(p.code().codes.back()) == *(code().codes[depth])) {
      std::list< NodeId > r_path;
      p.rightmostPath(r_path);
 
      for (const auto node: r_path) {
        for (const auto nei: children(node_map.first(node)))
          if (_rec_(p, node_map, node_map.first(node), nei)) return true;
 
        for (const auto nei: parents(node_map.first(node)))
          if (_rec_(p, node_map, node_map.first(node), nei)) return true;
      }
    }
 
    if (p.code().codes.back()->isForward()) node_map.eraseFirst(v);
 
    p.pop_back();
    return false;
  }

References Pattern(), _arc_map_, _rec_(), addArc(), addNodeWithLabel(), gum::ArcGraphPart::children(), code(), gum::prm::gspan::DFSCode::codes, gum::BijectionImplementation< T1, T2, Gen >::eraseFirst(), gum::ArcGraphPart::existsArc(), gum::BijectionImplementation< T1, T2, Gen >::existsFirst(), gum::BijectionImplementation< T1, T2, Gen >::first(), gum::BijectionImplementation< T1, T2, Gen >::insert(), label(), gum::ArcGraphPart::parents(), pop_back(), remove(), rightmostPath(), and gum::BijectionImplementation< T1, T2, Gen >::second().

Referenced by _expandCodeIsMinimal_(), and _rec_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addArc() [1/2]

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

overrideprivatevirtual

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::DiGraph.

Definition at line 203 of file diGraph_inl.h.

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

◆ addArc() [2/2]

INLINE void gum::prm::gspan::Pattern::addArc	(	NodeId	i,
		NodeId	j,
		LabelData &	l )

Add an arc to this Pattern.

This create an EdgeCode and check if it respects neighborhood restriction, if not an exception is raised.

Parameters

i	The DFS subscript of the first node in the code.
j	The DFS subscript of the second node in the code.
l	The label data of the added edge.

Exceptions

OperationNotAllowed Raised if the neighborhood restriction is not respected.

Definition at line 134 of file pattern_inl.h.

                                                           {
        if (!(DiGraph::exists(i) && DiGraph::exists(j))) {
          GUM_ERROR(NotFound, "node not found in this pattern")
        }
 
        EdgeCode* edge = new EdgeCode(i, j, _node_map_[i]->id, l.id, _node_map_[j]->id);
 
        if ((code().codes.size() == 0) || (DFSCode::validNeighbors(code().codes.back(), edge))) {
          DiGraph::addArc(i, j);
          _arc_map_.insert(Arc(i, j), std::make_pair(&l, edge));
          code().codes.push_back(edge);
        } else {
          delete edge;
          GUM_ERROR(OperationNotAllowed, "illegal arc considering neighborhood restriction")
        }
      }

References _arc_map_, _node_map_, gum::DiGraph::addArc(), code(), gum::prm::gspan::DFSCode::codes, gum::NodeGraphPart::exists(), GUM_ERROR, gum::prm::gspan::LabelData::id, and gum::prm::gspan::DFSCode::validNeighbors().

Referenced by Pattern(), gum::prm::gspan::DFSTree< GUM_SCALAR >::_checkGrowth_(), _expandCodeIsMinimal_(), _not_rec_(), _rec_(), and gum::prm::gspan::DFSTree< GUM_SCALAR >::addRoot().

Here is the call graph for this function:

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

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

References _boundVal_, _eraseHole_(), _holes_, _updateEndIteratorSafe_(), GUM_EMIT1, and onNodeAdded.

Referenced by gum::prm::gspan::DFSTree< GUM_SCALAR >::_addChild_(), gum::prm::StructuredInference< GUM_SCALAR >::_addEdgesInReducedGraph_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_buildPatternGraph_(), gum::prm::StructuredInference< GUM_SCALAR >::_buildPatternGraph_(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::_generateClassDag_(), gum::prm::LayerGenerator< GUM_SCALAR >::_generateClassDag_(), gum::prm::gspan::DFSTree< GUM_SCALAR >::addRoot(), and populateNodesFromProperty().

Here is the call graph for this function:

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

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

Referenced by gum::DiGraph::completeGraph(), gum::UndiGraph::completeGraph(), and populateNodesFromProperty().

Here is the caller 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

Reimplemented in gum::CliqueGraph.

Definition at line 214 of file nodeGraphPart.cpp.

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

References _boundVal_, _eraseHole_(), _holes_, _holes_resize_policy_, _holes_size_, _inHoles_(), _updateEndIteratorSafe_(), GUM_EMIT1, GUM_ERROR, and onNodeAdded.

Referenced by gum::EssentialGraph::_buildEssentialGraph_(), gum::prm::GSpan< GUM_SCALAR >::_sortPatterns_(), gum::prm::gspan::Pattern::addNodeWithLabel(), gum::InfluenceDiagram< GUM_SCALAR >::getDecisionGraph(), gum::Separation::isForwardSeparated(), gum::learning::IBNLearner::learnDag_(), gum::learning::FCI::learnPAG(), gum::learning::SimpleMiic::learnStructure(), gum::graph::markovBlanket(), gum::UndiGraph::partialUndiGraph(), populateNodesFromProperty(), gum::learning::IBNLearner::prepareFCI_(), gum::learning::IBNLearner::prepareMiic_(), gum::learning::IBNLearner::preparePC_(), gum::MeekRules::propagateToCPDAG(), gum::MeekRules::propagateToDAG(), gum::learning::StructuralConstraintDAG::setGraphAlone(), gum::EssentialGraph::skeleton(), and gum::PAG::toMixedGraph().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addNodeWithLabel()

INLINE NodeId gum::prm::gspan::Pattern::addNodeWithLabel ( LabelData & l )

Insert a node with the given LabelData.

Returns: The id assigned to the inserted node.

Definition at line 69 of file pattern_inl.h.

                                                   {
        NodeId n = NodeId(size() + 1);
        DiGraph::addNodeWithId(n);
        _node_map_.insert(n, &l);
        _last_ = &l;
        return n;
      }

References _last_, _node_map_, gum::NodeGraphPart::addNodeWithId(), and size().

Referenced by Pattern(), gum::prm::gspan::DFSTree< GUM_SCALAR >::_checkGrowth_(), _expandCodeIsMinimal_(), _not_rec_(), _rec_(), and gum::prm::gspan::DFSTree< GUM_SCALAR >::addRoot().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ancestors()

INLINE NodeSet gum::DiGraph::ancestors ( NodeId id ) const

inherited

returns the set of all ancestors of id (nodes from which id is reachable)

Definition at line 119 of file diGraph_inl.h.

119{ return graph::ancestors(*this, id); }

gum::graph::ancestors

NodeSet ancestors(const G &g, NodeId id)

Returns the set of all ancestors of id (nodes from which id is reachable following arc direction).

Definition reachability_tpl.h:57

References gum::graph::ancestors().

Referenced by gum::Separation::isAncestorOf(), and gum::DoorCriteria::nodesOnDirectedPaths().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ arcs()

INLINE const ArcSet & gum::prm::gspan::Pattern::arcs ( ) const

Definition at line 167 of file pattern_inl.h.

167{ return DiGraph::arcs(); }

gum::ArcGraphPart::arcs

const ArcSet & arcs() const

returns the set of arcs stored within the ArcGraphPart

Definition arcGraphPart_inl.h:60

References gum::ArcGraphPart::arcs().

Referenced by toDot().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ arcsProperty() [1/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.

◆ arcsProperty() [2/2]

template<typename VAL>

ArcProperty< VAL > gum::ArcGraphPart::arcsProperty	(	VAL(*	f )(const Arc &),
		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.

◆ 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())

gum::prm::gspan::Pattern::nodes
const NodeGraphPart & nodes() const
Definition pattern_inl.h:165

rather than
for(const auto n : asNodeSet())

gum::NodeGraphPart::asNodeSet
NodeSet asNodeSet() const
returns a copy of the set of nodes represented by the NodeGraphPart
Definition nodeGraphPart_inl.h:367

as this is faster and consumes much less memory.

Definition at line 367 of file nodeGraphPart_inl.h.

                                                {
    NodeSet son(sizeNodes());
 
    if (!empty()) {
      for (NodeId n = 0; n < _boundVal_; ++n) {
        if (!_inHoles_(n)) son.insert(n);
      }
    }
 
    return son;
  }

References _boundVal_, _inHoles_(), empty(), gum::Set< Key >::insert(), and sizeNodes().

Referenced by gum::MarginalTargetedInference< GUM_SCALAR >::MarginalTargetedInference(), gum::MarginalTargetedMRFInference< GUM_SCALAR >::MarginalTargetedMRFInference(), gum::DoCalculus< GUM_SCALAR >::_ancestorsIn_(), populateNodesFromProperty(), and gum::ImportanceSampling< GUM_SCALAR >::unsharpenBN_().

Here is the call graph for this function:

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

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

References NodeGraphPartIterator, and gum::NodeGraphPartIterator::validate_().

Referenced by gum::Estimator< GUM_SCALAR >::Estimator(), gum::learning::ConstraintBasedLearning::initGraph_(), populateNodesFromProperty(), and gum::Estimator< GUM_SCALAR >::setFromBN().

Here is the call graph for this function:

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

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

References NodeGraphPartIteratorSafe, and gum::NodeGraphPartIterator::validate_().

Referenced by populateNodesFromProperty().

Here is the call graph for this function:

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

323{ return _boundVal_; }

References _boundVal_.

Referenced by _clearNodes_(), and populateNodesFromProperty().

Here is the caller graph for this function:

◆ children() [1/2]

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

inherited

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

returns the set of children of a set of nodes

Definition at line 82 of file arcGraphPart_inl.h.

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

References children().

Referenced by ArcGraphPart(), gum::prm::ClassDependencyGraph< GUM_SCALAR >::_addArcs_(), gum::EssentialGraph::_buildEssentialGraph_(), gum::DoorCriteria::_existsUnblockedDirectedPath_(), gum::prm::gspan::Pattern::_expandCodeIsMinimal_(), gum::prm::SVE< GUM_SCALAR >::_initElimOrder_(), gum::prm::SVED< GUM_SCALAR >::_initElimOrder_(), gum::prm::gspan::Pattern::_not_rec_(), gum::MeekRules::_propagatesOrientationInChainOfRemainingEdges_(), gum::prm::gspan::Pattern::_rec_(), gum::DoCalculus< GUM_SCALAR >::_removeInIntoDoing_outOfKnowing_(), gum::BarrenNodesFinder::barrenNodes(), children(), gum::DoorCriteria::enumerateFrontdoorSets(), eraseChildren(), gum::PDAG::hasMixedReallyOrientedPath(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::initialize_(), gum::Separation::isBackdoorSeparated(), gum::Separation::isForwardSeparated(), gum::prm::gspan::Pattern::isMinimal(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::makeInferenceNodeToNeighbours_(), operator<<(), gum::learning::SimpleMiic::propagatesOrientationInChainOfRemainingEdges_(), gum::rec_hasMixedReallyOrientedPath(), gum::BayesBall::relevantTensors(), gum::dSeparationAlgorithm::relevantTensors(), gum::prm::gspan::Pattern::remove(), gum::dSeparationAlgorithm::requisiteNodes(), gum::DAGCycleDetector::setDAG(), gum::MixedGraph::toDot(), gum::PDAG::toDot(), and unvirtualizedEraseChildren().

Here is the call graph for this function:

◆ children() [2/2]

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 97 of file arcGraphPart_inl.h.

                                                              {
    if (_children_.exists(id)) return *_children_[id];
    else return emptyNodeSet;
  }

References _children_, and gum::emptyNodeSet.

◆ clear()

INLINE void gum::DiGraph::clear ( )

overridevirtualinherited

removes all the nodes and arcs from the graph

Reimplemented from gum::NodeGraphPart.

Reimplemented in gum::MixedGraph.

Definition at line 67 of file diGraph_inl.h.

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

References gum::ArcGraphPart::clearArcs(), and gum::NodeGraphPart::clearNodes().

Referenced by operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearArcs()

void gum::ArcGraphPart::clearArcs ( )

inherited

removes all the arcs from the ArcGraphPart

Definition at line 104 of file arcGraphPart.cpp.

                               {
    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();
    }
  }

References _arcs_, _children_, _parents_, GUM_EMIT2, and onArcDeleted.

Referenced by ~ArcGraphPart(), gum::DiGraph::clear(), gum::MixedGraph::clear(), operator=(), operator=(), and gum::MixedGraph::operator=().

Here is the caller graph for this function:

◆ clearNodes()

INLINE void gum::NodeGraphPart::clearNodes ( )

virtualinherited

remove all the nodes from the NodeGraphPart

Definition at line 325 of file nodeGraphPart_inl.h.

325{ _clearNodes_(); }

gum::NodeGraphPart::_clearNodes_

void _clearNodes_()

code for clearing nodes (called twice)

Definition nodeGraphPart.cpp:237

References _clearNodes_().

Referenced by gum::DiGraph::clear(), gum::MixedGraph::clear(), gum::UndiGraph::clear(), gum::MixedGraph::operator=(), operator=(), and populateNodesFromProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ code() [1/2]

INLINE DFSCode & gum::prm::gspan::Pattern::code ( )

Returns the DFSCode of this Pattern.

Definition at line 170 of file pattern_inl.h.

170{ return _code_; }

gum::prm::gspan::Pattern::_code_

DFSCode _code_

The DFSCode of this Pattern.

Definition pattern.h:222

References _code_.

Referenced by Pattern(), gum::prm::gspan::DFSTree< GUM_SCALAR >::_addChild_(), gum::prm::gspan::DFSTree< GUM_SCALAR >::_checkGrowth_(), _not_rec_(), _rec_(), gum::prm::GSpan< GUM_SCALAR >::_subgraph_mining_(), addArc(), and isMinimal().

Here is the caller graph for this function:

◆ code() [2/2]

INLINE const DFSCode & gum::prm::gspan::Pattern::code ( ) const

Returns the DFSCode of this Pattern.

Definition at line 173 of file pattern_inl.h.

173{ return _code_; }

References _code_.

◆ completeGraph()

DiGraph gum::DiGraph::completeGraph ( int n )

staticinherited

Build a complete DiGraph with n nodes.

Parameters

int n

Returns: the complete DiGraph

Definition at line 58 of file diGraph.cpp.

                                      {
    DiGraph g;
    g.addNodes(n);
 
    for (int j = 0; j < n; ++j) {
      for (int k = j + 1; k < n; ++k) {
        g.addArc(j, k);
      }
    }
    return g;
  }

References DiGraph(), addArc(), and gum::NodeGraphPart::addNodes().

Here is the call graph for this function:

◆ connectedComponents()

INLINE NodeProperty< NodeId > gum::DiGraph::connectedComponents ( ) const

inherited

returns a property {node:id of weakly connected component}

Definition at line 127 of file diGraph_inl.h.

                                                                   {
    return graph::connectedComponents(*this);
  }

References gum::graph::connectedComponents().

Here is the call graph for this function:

◆ descendants()

INLINE NodeSet gum::DiGraph::descendants ( NodeId id ) const

inherited

returns the set of all descendants of id (nodes reachable from id)

Definition at line 121 of file diGraph_inl.h.

121{ return graph::descendants(*this, id); }

gum::graph::descendants

NodeSet descendants(const G &g, NodeId id)

Returns the set of all descendants of id (nodes reachable from id following arc direction).

Definition reachability_tpl.h:73

References gum::graph::descendants().

Referenced by gum::DoorCriteria::enumerateBackdoorSets(), gum::Separation::isDescendantOf(), gum::DoorCriteria::nodesOnDirectedPaths(), and gum::DoorCriteria::satisfiesBackdoorCriterion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ directedPath()

INLINE std::optional< std::vector< NodeId > > gum::DiGraph::directedPath	(	NodeId	node1,
		NodeId	node2 ) const

inherited

returns a directed path from node1 to node2, or std::nullopt if none

Definition at line 109 of file diGraph_inl.h.

                                                                                          {
    return graph::directedPath(*this, node1, node2);
  }

References gum::graph::directedPath().

Here is the call graph for this function:

◆ directedUnorientedPath()

INLINE std::optional< std::vector< NodeId > > gum::DiGraph::directedUnorientedPath	(	NodeId	node1,
		NodeId	node2 ) const

inherited

returns a shortest path from node1 to node2 ignoring arc orientation, or std::nullopt if none

Definition at line 115 of file diGraph_inl.h.

                                                                         {
    return graph::directedUnorientedPath(*this, node1, node2);
  }

References gum::graph::directedUnorientedPath().

Here is the call graph for this function:

◆ dotNodeLabel()

std::string gum::NodeGraphPart::dotNodeLabel ( NodeId id ) const

inherited

returns " [label=\"...\"]" with DOT-escaped name, or "" if no name

Definition at line 188 of file nodeGraphPart.cpp.

                                                       {
    if (!hasName(id)) return "";
    const std::string& name = _names_->second(id);
    std::string        result;
    result.reserve(name.size() * 2 + 24);
    result = " [label=\"(";
    result += std::to_string(id);
    result += ") ";
    for (const char c: name) {
      switch (c) {
        case '"' : result += "\\\""; break;
        case '\\' : result += "\\\\"; break;
        case '\n' : result += "\\n"; break;
        case '\r' : result += "\\r"; break;
        default : result += c;
      }
    }
    result += "\"]";
    return result;
  }

References _names_, and hasName().

Referenced by populateNodesFromProperty(), gum::DiGraph::toDot(), gum::MixedGraph::toDot(), gum::PAG::toDot(), gum::PDAG::toDot(), and gum::UndiGraph::toDot().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ edgeCode() [1/4]

INLINE EdgeCode & gum::prm::gspan::Pattern::edgeCode ( const Arc & arc )

Returns the EdgeCode of an edge of this Pattern.

Definition at line 183 of file pattern_inl.h.

                                                {
        auto p = _arc_map_.tryGet(arc);
        if (!p) GUM_ERROR(NotFound, "arc not found in Pattern")
        return *(p->second);
      }

References _arc_map_, and GUM_ERROR.

◆ edgeCode() [2/4]

INLINE const EdgeCode & gum::prm::gspan::Pattern::edgeCode ( const Arc & arc ) const

Returns the EdgeCode of an edge of this Pattern.

Definition at line 197 of file pattern_inl.h.

                                                            {
        auto p = _arc_map_.tryGet(arc);
        if (!p) GUM_ERROR(NotFound, "arc not found in Pattern")
        return *(p->second);
      }

References _arc_map_, and GUM_ERROR.

◆ edgeCode() [3/4]

INLINE EdgeCode & gum::prm::gspan::Pattern::edgeCode	(	NodeId	tail,
		NodeId	head )

Returns the EdgeCode of an edge of this Pattern.

Definition at line 176 of file pattern_inl.h.

                                                          {
        auto p = _arc_map_.tryGet(Arc(tail, head));
        if (!p) GUM_ERROR(NotFound, "arc not found in Pattern")
        return *(p->second);
      }

References _arc_map_, and GUM_ERROR.

Referenced by gum::prm::gspan::DFSTree< GUM_SCALAR >::_checkGrowth_().

Here is the caller graph for this function:

◆ edgeCode() [4/4]

INLINE const EdgeCode & gum::prm::gspan::Pattern::edgeCode	(	NodeId	tail,
		NodeId	head ) const

Returns the EdgeCode of an edge of this Pattern.

Definition at line 190 of file pattern_inl.h.

                                                                      {
        auto p = _arc_map_.tryGet(Arc(tail, head));
        if (!p) GUM_ERROR(NotFound, "arc not found in Pattern")
        return *(p->second);
      }

References _arc_map_, and GUM_ERROR.

◆ empty()

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

inherited

alias for emptyNodes

Definition at line 321 of file nodeGraphPart_inl.h.

321{ return emptyNodes(); }

gum::NodeGraphPart::emptyNodes

bool emptyNodes() const

indicates whether there exists nodes in the NodeGraphPart

Definition nodeGraphPart_inl.h:319

References emptyNodes().

Referenced by asNodeSet(), populateNodesFromProperty(), gum::prm::gspan::Pattern::remove(), and gum::PDAG::toDot().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ emptyArcs()

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

inherited

indicates wether the ArcGraphPart contains any arc

Definition at line 56 of file arcGraphPart_inl.h.

56{ return _arcs_.empty(); }

References _arcs_.

◆ emptyNodes()

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

inherited

indicates whether there exists nodes in the NodeGraphPart

Definition at line 319 of file nodeGraphPart_inl.h.

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

References sizeNodes().

Referenced by empty(), and populateNodesFromProperty().

Here is the call graph for this function:

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

                                                                        {
    return _endIteratorSafe_;
  }

References _endIteratorSafe_, and NodeGraphPartIterator.

Referenced by gum::Estimator< GUM_SCALAR >::Estimator(), gum::learning::ConstraintBasedLearning::initGraph_(), populateNodesFromProperty(), and gum::Estimator< GUM_SCALAR >::setFromBN().

Here is the call graph for this function:

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

                                                                                {
    return _endIteratorSafe_;
  }

References _endIteratorSafe_, and NodeGraphPartIteratorSafe.

Referenced by populateNodesFromProperty().

Here is the call graph for this function:

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

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

References _arcs_, _children_, _parents_, existsArc(), GUM_EMIT2, gum::Arc::head(), onArcDeleted, and gum::Arc::tail().

Referenced by gum::EssentialGraph::_buildEssentialGraph_(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::_generateClassDag_(), gum::prm::LayerGenerator< GUM_SCALAR >::_generateClassDag_(), gum::MeekRules::_orientDoubleHeadedArcs_(), gum::DoCalculus< GUM_SCALAR >::_removeIncomingInto_(), gum::DoCalculus< GUM_SCALAR >::_removeInIntoDoing_outOfKnowing_(), gum::BarrenNodesFinder::barrenNodes(), eraseChildren(), eraseParents(), eraseSetOfArcs_(), gum::Separation::isBackdoorSeparated(), gum::learning::IBNLearner::learnDag_(), gum::learning::SimpleMiic::learnStructure(), gum::learning::ConstraintBasedLearning::orientDoubleHeadedArcs_(), gum::prm::gspan::Pattern::pop_back(), gum::BayesNet< GUM_SCALAR >::reverseArc(), unvirtualizedEraseChildren(), unvirtualizedEraseParents(), and unvirtualizedEraseSetOfArcs_().

Here is the call graph for this function:

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

                                                   {
    if (_children_.exists(id)) {
      const 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 virtualized
        // arc removal function
        eraseArc(Arc(id, *iter));
      }
    }
  }

References _children_, children(), and eraseArc().

Here is the call graph for this function:

◆ eraseNode()

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

overridevirtualinherited

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 93 of file diGraph_inl.h.

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

References gum::NodeGraphPart::eraseNode(), gum::ArcGraphPart::unvirtualizedEraseChildren(), and gum::ArcGraphPart::unvirtualizedEraseParents().

Referenced by gum::BarrenNodesFinder::barrenNodes(), gum::prm::gspan::Pattern::pop_back(), gum::Separation::reduceForDSeparation(), and gum::prm::gspan::Pattern::remove().

Here is the call graph for this function:

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

                                                  {
    if (_parents_.exists(id)) {
      const 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));
      }
    }
  }

References _parents_, eraseArc(), and parents().

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 127 of file arcGraphPart_inl.h.

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

References eraseArc().

Here is the call graph for this function:

◆ exists() [1/2]

INLINE bool gum::prm::gspan::Pattern::exists ( NodeId id ) const

Returns true if id is a node in this Pattern.

Definition at line 152 of file pattern_inl.h.

152{ return DiGraph::exists(id); }

References gum::NodeGraphPart::exists().

Here is the call graph for this function:

◆ exists() [2/2]

INLINE bool gum::prm::gspan::Pattern::exists	(	NodeId	tail,
		NodeId	head ) const

Returns true if (tail, head) is an arc in this Pattern.

Definition at line 155 of file pattern_inl.h.

                                                         {
        return DiGraph::existsArc(tail, head);
      }

References gum::ArcGraphPart::existsArc().

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 62 of file arcGraphPart_inl.h.

62{ return _arcs_.contains(arc); }

References _arcs_.

Referenced by gum::DoorCriteria::_existsUnblockedDirectedPath_(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::_generateClassDag_(), gum::prm::LayerGenerator< GUM_SCALAR >::_generateClassDag_(), gum::prm::gspan::Pattern::_not_rec_(), gum::MeekRules::_propagatesOrientationInChainOfRemainingEdges_(), gum::prm::gspan::Pattern::_rec_(), gum::EssentialGraph::_strongly_protected_(), gum::DoorCriteria::enumerateBackdoorSets(), eraseArc(), gum::prm::gspan::Pattern::exists(), gum::Separation::isBackdoorSeparated(), and gum::graph::markovBlanket().

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

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

References _parents_.

◆ existsNode()

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

inherited

returns true iff the NodeGraphPart contains the given nodeId

Definition at line 301 of file nodeGraphPart_inl.h.

                                                               {
    if (node >= _boundVal_) return false;
 
    return (!_inHoles_(node));
  }

References _boundVal_, and _inHoles_().

Referenced by eraseNode(), gum::PAG::eraseNode(), exists(), gum::InfluenceDiagram< GUM_SCALAR >::getDecisionGraph(), gum::Separation::isForwardSeparated(), gum::graph::markovBlanket(), gum::graph::moralizedAncestralGraph(), gum::UndiGraph::partialUndiGraph(), populateNodesFromProperty(), gum::Separation::reduceForDSeparation(), and setName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ family() [1/2]

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

inherited

returns the union of families of all nodes in ids

Definition at line 125 of file diGraph_inl.h.

125{ return graph::family(*this, ids); }

gum::graph::family

NodeSet family(const G &g, NodeId id)

Returns the family of id : { id } ∪ parents(id).

Definition reachability_tpl.h:89

References gum::graph::family().

Here is the call graph for this function:

◆ family() [2/2]

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

inherited

returns { id } ∪ parents(id)

Definition at line 123 of file diGraph_inl.h.

123{ return graph::family(*this, id); }

References gum::graph::family().

Here is the call graph for this function:

◆ hasDirectedPath()

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

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 114 of file diGraph.cpp.

                                                                        {
    return graph::hasDirectedPath(*this, from, to);
  }

References gum::graph::hasDirectedPath().

Referenced by gum::DAG::addArc(), and gum::PDAG::addArc().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasName()

bool gum::NodeGraphPart::hasName ( NodeId id ) const

inherited

returns true iff node id has an explicit name

Definition at line 186 of file nodeGraphPart.cpp.

186{ return _names_ && _names_->existsFirst(id); }

References _names_.

Referenced by dotNodeLabel(), and populateNodesFromProperty().

Here is the caller graph for this function:

◆ idFromName()

std::optional< NodeId > gum::NodeGraphPart::idFromName ( const std::string & name ) const

inherited

returns the id of the node with the given name, or std::nullopt

Definition at line 165 of file nodeGraphPart.cpp.

                                                                             {
    if (_names_ && _names_->existsSecond(name)) return _names_->first(name);
    return std::nullopt;
  }

References _names_.

Referenced by populateNodesFromProperty().

Here is the caller graph for this function:

◆ isMinimal()

bool gum::prm::gspan::Pattern::isMinimal ( )

Returns the DFSCode of this Pattern.

Definition at line 71 of file pattern.cpp.

                          {
    for (const auto node: nodes()) {
      for (const auto next: parents(node)) {
        Size     u = label(node).id;
        Size     v = label(next).id;
        EdgeCode edge_code(1, 2, u, label(next, node).id, v);
 
        if (edge_code < *(code().codes.front())) {
          return false;
        } else if (edge_code == (*code().codes.front())) {
          if (_expandCodeIsMinimal_(node, next)) { return false; }
        }
      }
 
      for (const auto next: children(node)) {
        Size     u = label(node).id;
        Size     v = label(next).id;
        EdgeCode edge_code(1, 2, u, label(node, next).id, v);
 
        if (edge_code < *(code().codes.front())) {
          return false;
        } else if (edge_code == (*code().codes.front())) {
          if (_expandCodeIsMinimal_(node, next)) { return false; }
        }
      }
    }
 
    return true;
  }

References _expandCodeIsMinimal_(), gum::ArcGraphPart::children(), code(), gum::prm::gspan::LabelData::id, label(), nodes(), and gum::ArcGraphPart::parents().

Referenced by gum::prm::gspan::DFSTree< GUM_SCALAR >::_checkGrowth_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ label() [1/6]

INLINE LabelData & gum::prm::gspan::Pattern::label ( const Arc & arc )

Returns the LabelData assigned to arc.

Definition at line 120 of file pattern_inl.h.

                                              {
        auto p = _arc_map_.tryGet(arc);
        if (!p) GUM_ERROR(NotFound, "arc not found in this Pattern")
        return *(p->first);
      }

References _arc_map_, and GUM_ERROR.

◆ label() [2/6]

INLINE const LabelData & gum::prm::gspan::Pattern::label ( const Arc & arc ) const

Returns the LabelData assigned to arc.

Definition at line 127 of file pattern_inl.h.

                                                          {
        auto p = _arc_map_.tryGet(arc);
        if (!p) GUM_ERROR(NotFound, "arc not found in this Pattern")
        return *(p->first);
      }

References _arc_map_, and GUM_ERROR.

◆ label() [3/6]

INLINE LabelData & gum::prm::gspan::Pattern::label	(	NodeId	i,
		NodeId	j )

Returns the LabelData assigned to arc.

Definition at line 106 of file pattern_inl.h.

                                                  {
        auto p = _arc_map_.tryGet(Arc(i, j));
        if (!p) GUM_ERROR(NotFound, "arc not found in this Pattern")
        return *(p->first);
      }

References _arc_map_, and GUM_ERROR.

◆ label() [4/6]

INLINE const LabelData & gum::prm::gspan::Pattern::label	(	NodeId	i,
		NodeId	j ) const

Returns the LabelData assigned to arc.

Definition at line 113 of file pattern_inl.h.

                                                              {
        auto p = _arc_map_.tryGet(Arc(i, j));
        if (!p) GUM_ERROR(NotFound, "arc not found in this Pattern")
        return *(p->first);
      }

References _arc_map_, and GUM_ERROR.

◆ label() [5/6]

INLINE LabelData & gum::prm::gspan::Pattern::label ( NodeId node )

Returns the LabelData assigned to node.

Definition at line 78 of file pattern_inl.h.

                                           {
        auto p = _node_map_.tryGet(node);
        if (!p) GUM_ERROR(NotFound, "node not found in this Pattern")
        return *(*p);
      }

References _node_map_, and GUM_ERROR.

Referenced by Pattern(), _expandCodeIsMinimal_(), _not_rec_(), _rec_(), gum::prm::gspan::TreeWidthSearch< GUM_SCALAR >::accept_root(), isMinimal(), and toDot().

Here is the caller graph for this function:

◆ label() [6/6]

INLINE const LabelData & gum::prm::gspan::Pattern::label ( NodeId node ) const

Returns the LabelData assigned to node.

Definition at line 85 of file pattern_inl.h.

                                                       {
        auto p = _node_map_.tryGet(node);
        if (!p) GUM_ERROR(NotFound, "node not found in this Pattern")
        return *(*p);
      }

References _node_map_, and GUM_ERROR.

◆ lastAdded() [1/2]

INLINE LabelData & gum::prm::gspan::Pattern::lastAdded ( )

Insert a node with the given LabelData.

Returns: The id assigned to the inserted node.

Definition at line 92 of file pattern_inl.h.

                                    {
        if (_last_) return *_last_;
 
        GUM_ERROR(OperationNotAllowed, "there are no LabelData yet")
      }

References _last_, and GUM_ERROR.

◆ lastAdded() [2/2]

INLINE const LabelData & gum::prm::gspan::Pattern::lastAdded ( ) const

Insert a node with the given LabelData.

Returns: The id assigned to the inserted node.

Definition at line 99 of file pattern_inl.h.

                                                {
        if (_last_) return *_last_;
 
        GUM_ERROR(OperationNotAllowed, "there are no LabelData yet")
      }

References _last_, and GUM_ERROR.

◆ listMapArcs()

template<typename VAL>

List< VAL > gum::ArcGraphPart::listMapArcs ( VAL(* f )(const Arc &) ) 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(* f )(const NodeId &) ) 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

References listMapNodes().

Referenced by listMapNodes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nameFromId()

std::string gum::NodeGraphPart::nameFromId ( NodeId id ) const

inherited

returns the name of node id, or "<id>" if no name is set

Definition at line 160 of file nodeGraphPart.cpp.

                                                     {
    if (_names_ && _names_->existsFirst(id)) return _names_->second(id);
    return std::to_string(id);
  }

References _names_.

Referenced by populateNodesFromProperty().

Here is the caller 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);

gum::NodeGraphPart::nextNodeId
NodeId nextNodeId() const
returns a new node id, not yet used by any node
Definition nodeGraphPart_inl.h:243

gum::NodeGraphPart::addNode
virtual NodeId addNode()
insert a new node and return its id
Definition nodeGraphPart_inl.h:269

is basically not thread safe !!

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

Definition at line 243 of file nodeGraphPart_inl.h.

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

References _boundVal_, and _holes_.

Referenced by populateNodesFromProperty().

Here is the caller graph for this function:

◆ nodes()

INLINE const NodeGraphPart & gum::prm::gspan::Pattern::nodes ( ) const

Definition at line 165 of file pattern_inl.h.

165{ return DiGraph::nodes(); }

gum::NodeGraphPart::nodes

const NodeGraphPart & nodes() const

return *this as a NodeGraphPart

Definition nodeGraphPart_inl.h:379

References gum::NodeGraphPart::NodeGraphPart(), and gum::NodeGraphPart::nodes().

Referenced by gum::prm::gspan::TreeWidthSearch< GUM_SCALAR >::accept_root(), and isMinimal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nodesPropertyFromFunction()

template<typename VAL>

NodeProperty< VAL > gum::NodeGraphPart::nodesPropertyFromFunction	(	VAL(*	f )(const NodeId &),
		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.

References nodesPropertyFromFunction(), and size().

Referenced by nodesPropertyFromFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nodesPropertyFromVal()

template<typename VAL>

NodeProperty< VAL > gum::NodeGraphPart::nodesPropertyFromVal	(	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.

References nodesPropertyFromVal(), and size().

Referenced by gum::BinaryJoinTreeConverterDefault::convert(), and nodesPropertyFromVal().

Here is the call graph for this function:

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

189{ return _arcs_ == p._arcs_; }

References ArcGraphPart(), and _arcs_.

Referenced by gum::DiGraph::operator==(), and gum::MixedGraph::operator==().

Here is the call graph for this function:

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

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

References DiGraph(), gum::ArcGraphPart::operator==(), and gum::NodeGraphPart::operator==().

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 356 of file nodeGraphPart_inl.h.

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

References NodeGraphPart(), _boundVal_, and _holes_.

Referenced by gum::DiGraph::operator==(), gum::MixedGraph::operator==(), and gum::UndiGraph::operator==().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parents() [1/2]

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

inherited

returns the set of parents of a set of nodes

Definition at line 90 of file arcGraphPart_inl.h.

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

References parents().

Here is the call graph for this function:

◆ parents() [2/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 76 of file arcGraphPart_inl.h.

                                                             {
    if (_parents_.exists(id)) return *(_parents_[id]);
    else return emptyNodeSet;
  }

References _parents_, and gum::emptyNodeSet.

Referenced by gum::DoCalculus< GUM_SCALAR >::_ancestorsIn_(), gum::prm::gspan::Pattern::_expandCodeIsMinimal_(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::_generateClass_(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::_generateClassDag_(), gum::prm::LayerGenerator< GUM_SCALAR >::_generateClassDag_(), gum::prm::LayerGenerator< GUM_SCALAR >::_generateClasses_(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::_generateCluster_(), gum::prm::SVE< GUM_SCALAR >::_initElimOrder_(), gum::prm::SVED< GUM_SCALAR >::_initElimOrder_(), gum::prm::SVE< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::SVED< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::gspan::Pattern::_not_rec_(), gum::MeekRules::_orientDoubleHeadedArcs_(), gum::prm::gspan::Pattern::_rec_(), gum::DoCalculus< GUM_SCALAR >::_removeIncomingInto_(), gum::DoCalculus< GUM_SCALAR >::_removeInIntoDoing_outOfKnowing_(), gum::EssentialGraph::_strongly_protected_(), gum::DoorCriteria::backdoorReach(), gum::BarrenNodesFinder::barrenNodes(), gum::DoorCriteria::enumerateBackdoorSets(), gum::DoorCriteria::enumerateFrontdoorSets(), eraseParents(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::initialize_(), gum::prm::gspan::Pattern::isMinimal(), gum::learning::SimpleMiic::learnPDAG(), gum::learning::SimpleMiic::learnStructure(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::makeInferenceNodeToNeighbours_(), operator<<(), gum::learning::ConstraintBasedLearning::orientDoubleHeadedArcs_(), gum::prm::gspan::DFSTree< GUM_SCALAR >::parent(), gum::prm::gspan::DFSTree< GUM_SCALAR >::parent(), parents(), gum::BayesBall::relevantTensors(), gum::dSeparationAlgorithm::relevantTensors(), gum::prm::gspan::Pattern::remove(), gum::dSeparationAlgorithm::requisiteNodes(), gum::prm::gspan::Pattern::rightmostPath(), gum::DAGCycleDetector::setDAG(), and unvirtualizedEraseParents().

◆ pop_back()

INLINE void gum::prm::gspan::Pattern::pop_back ( )

Remove the last EdgeCode of this pattern.

Definition at line 204 of file pattern_inl.h.

                             {
        EdgeCode* edge = _code_.codes.back();
        _code_.codes.pop_back();
 
        if (edge->isForward()) {
          _node_map_.erase(edge->j);
          _arc_map_.erase(Arc(edge->i, edge->j));
          DiGraph::eraseArc(Arc(edge->i, edge->j));
          DiGraph::eraseNode(edge->j);
        } else {
          _arc_map_.erase(Arc(edge->i, edge->j));
          DiGraph::eraseArc(Arc(edge->i, edge->j));
        }
 
        delete edge;
      }

References _arc_map_, _code_, _node_map_, gum::ArcGraphPart::eraseArc(), gum::DiGraph::eraseNode(), gum::prm::gspan::EdgeCode::i, gum::prm::gspan::EdgeCode::isForward(), and gum::prm::gspan::EdgeCode::j.

Referenced by _not_rec_(), and _rec_().

Here is the call graph for this function:

Here is the caller 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 97 of file nodeGraphPart.cpp.

                                                          {
    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_);
 
    _names_ = s._cloneNames_();
 
    _boundVal_ = s._boundVal_;
 
    _updateEndIteratorSafe_();
  }

References NodeGraphPart(), _boundVal_, _cloneNames_(), _holes_, _holes_resize_policy_, _holes_size_, _names_, _updateEndIteratorSafe_(), and clear().

Referenced by operator=().

Here is the call graph for this function:

Here is the caller 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.

References NodeGraphPart(), addNode(), addNodes(), addNodeWithId(), asNodeSet(), begin(), beginSafe(), bound(), clear(), clearNodes(), dotNodeLabel(), empty(), emptyNodes(), end(), endSafe(), eraseNode(), exists(), existsNode(), hasName(), idFromName(), nameFromId(), nextNodeId(), nodes(), setName(), size(), sizeNodes(), and toString().

Here is the call graph for this function:

◆ remove()

INLINE void gum::prm::gspan::Pattern::remove ( NodeId node )

Remove a node if it has no neighbors, raise an OperationNotAllowed otherwise.

Definition at line 222 of file pattern_inl.h.

                                      {
        if (DiGraph::parents(node).empty() && DiGraph::children(node).empty()) {
          DiGraph::eraseNode(node);
          _node_map_.erase(node);
        } else {
          GUM_ERROR(OperationNotAllowed, "the given node has neighbors")
        }
      }

References _node_map_, gum::ArcGraphPart::children(), gum::NodeGraphPart::empty(), gum::DiGraph::eraseNode(), GUM_ERROR, and gum::ArcGraphPart::parents().

Referenced by _not_rec_(), and _rec_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rightmostPath()

void gum::prm::gspan::Pattern::rightmostPath ( std::list< NodeId > & r_path ) const

Fill r_path with the rightmost path of this Pattern. The list is supposed empty.

Definition at line 282 of file pattern.cpp.

                                                             {
    r_path.push_back(NodeId(size()));
 
    while (r_path.front() != 1) {
      for (const auto par: parents(r_path.front())) {
        if (par < r_path.front()) {
          r_path.push_front(par);
          break;
        }
      }
    }
  }

References gum::ArcGraphPart::parents(), and size().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setName()

void gum::NodeGraphPart::setName	(	NodeId	id,
		const std::string &	name )

inherited

sets the name of node id

Exceptions

DuplicateElement if name is already used by another node

Definition at line 170 of file nodeGraphPart.cpp.

                                                              {
    if (!existsNode(id)) GUM_ERROR(InvalidNode, "node " << id << " does not exist")
    if (_names_) {
      auto owner = _names_->tryFirst(name);
      if (owner.has_value()) {
        if (*owner != id)
          GUM_ERROR(DuplicateElement, "name '" << name << "' already used by node " << *owner)
        return;
      }
      if (_names_->existsFirst(id)) _names_->eraseFirst(id);
    } else {
      _names_ = std::make_unique< Bijection< NodeId, std::string > >();
    }
    _names_->insert(id, name);
  }

References _names_, existsNode(), and GUM_ERROR.

Referenced by gum::GraphicalModel::_nameNodes_(), gum::CausalModel< GUM_SCALAR >::causalDAG(), populateNodesFromProperty(), and gum::EssentialGraph::skeleton().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ size()

INLINE Size gum::prm::gspan::Pattern::size ( ) const

Returns the number of nodes in this Pattern.

Definition at line 160 of file pattern_inl.h.

160{ return DiGraph::size(); }

gum::NodeGraphPart::size

Size size() const

alias for sizeNodes

Definition nodeGraphPart_inl.h:299

References gum::NodeGraphPart::size().

Referenced by Pattern(), addNodeWithLabel(), and rightmostPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sizeArcs()

INLINE Size gum::prm::gspan::Pattern::sizeArcs ( ) const

Returns the number of arcs in this Pattern.

Definition at line 163 of file pattern_inl.h.

163{ return DiGraph::sizeArcs(); }

gum::ArcGraphPart::sizeArcs

Size sizeArcs() const

indicates the number of arcs stored within the ArcGraphPart

Definition arcGraphPart_inl.h:58

References gum::ArcGraphPart::sizeArcs().

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 295 of file nodeGraphPart_inl.h.

                                             {
    return (_holes_) ? (_boundVal_ - _holes_->size()) : _boundVal_;
  }

References _boundVal_, and _holes_.

Referenced by gum::BinaryJoinTreeConverterDefault::_markConnectedComponent_(), asNodeSet(), gum::BinaryJoinTreeConverterDefault::convert(), emptyNodes(), populateNodesFromProperty(), and size().

Here is the caller graph for this function:

◆ toDot() [1/2]

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

privatevirtual

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 from gum::DiGraph.

Definition at line 220 of file diGraph.cpp.

                                 {
    std::string strBuff = "digraph {\n";
 
    for (const auto node: nodes())
      strBuff += std::format("     {}{};\n", node, dotNodeLabel(node));
 
    strBuff += "\n";
 
    for (const auto& arc: arcs())
      strBuff += std::format("     {} -> {};\n", arc.tail(), arc.head());
 
    strBuff += "}\n\n";
    return strBuff;
  }

◆ toDot() [2/2]

std::string gum::prm::gspan::Pattern::toDot ( size_t name ) const

Print the pattern in the DOT syntax.

Definition at line 101 of file pattern.cpp.

                                            {
    std::string result = std::format("digraph {} {{\n", name);
 
    for (const auto& arc: arcs())
      result += std::format("{} -> {};\n", label(arc.tail()).id, label(arc.head()).id);
 
    result += "}\n";
    return result;
  }

References arcs(), gum::prm::gspan::LabelData::id, and label().

Here is the call graph for this function:

◆ topologicalOrder()

INLINE Sequence< NodeId > gum::DiGraph::topologicalOrder ( ) const

inherited

Build and return a topological order.

Exceptions

InvalidDirectedCycle Raised if this DiGraph contains cycles.

Definition at line 131 of file diGraph_inl.h.

                                                            {
    return graph::topologicalOrder(*this);
  }

References gum::graph::topologicalOrder().

Referenced by gum::learning::SimpleMiic::learnPDAG(), and gum::learning::SimpleMiic::learnStructure().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toString()

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

overridevirtualinherited

to friendly display the content of the graph

Reimplemented from gum::NodeGraphPart.

Reimplemented in gum::MixedGraph.

Definition at line 86 of file diGraph.cpp.

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

References gum::ArcGraphPart::toString(), and gum::NodeGraphPart::toString().

Referenced by gum::operator<<().

Here is the call graph for this function:

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

                                                                {
    if (_children_.exists(id)) {
      const NodeSet& children = *(_children_[id]);
 
      for (auto iter = children.beginSafe();   // safe iterator needed here
           iter != children.endSafe();
           ++iter) {
        ArcGraphPart::eraseArc(Arc(id, *iter));
      }
    }
  }

References _children_, children(), and eraseArc().

Referenced by gum::DiGraph::eraseNode(), and gum::MixedGraph::eraseNode().

Here is the call graph for this function:

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

                                                               {
    if (_parents_.exists(id)) {
      const NodeSet& parents = *(_parents_[id]);
 
      for (auto iter = parents.beginSafe();   // safe iterator needed here
           iter != parents.endSafe();
           ++iter) {
        ArcGraphPart::eraseArc(Arc(*iter, id));
      }
    }
  }

References _parents_, eraseArc(), and parents().

Referenced by gum::DiGraph::eraseNode(), and gum::MixedGraph::eraseNode().

Here is the call graph for this function:

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

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

References eraseArc().

Here is the call graph for this function:

Member Data Documentation

◆ _arc_map_

ArcProperty< std::pair< LabelData*, EdgeCode* > > gum::prm::gspan::Pattern::_arc_map_

private

Mapping between edges in this Pattern and their respective LabelData.

Definition at line 230 of file pattern.h.

Referenced by _expandCodeIsMinimal_(), _not_rec_(), _rec_(), addArc(), edgeCode(), edgeCode(), edgeCode(), edgeCode(), label(), label(), label(), label(), and pop_back().

◆ _arcs_

Set< Arc > gum::ArcGraphPart::_arcs_

privateinherited

the set of all the arcs contained within the ArcGraphPart

Definition at line 281 of file arcGraphPart.h.

Referenced by ArcGraphPart(), ArcGraphPart(), ArcGraphPart(), addArc(), arcs(), clearArcs(), emptyArcs(), eraseArc(), existsArc(), operator=(), operator=(), operator==(), sizeArcs(), and toString().

◆ _children_

NodeProperty< NodeSet* > gum::ArcGraphPart::_children_

privateinherited

for each arc, the set of its children

Definition at line 287 of file arcGraphPart.h.

Referenced by ArcGraphPart(), ArcGraphPart(), _checkChildren_(), addArc(), children(), clearArcs(), eraseArc(), eraseChildren(), operator=(), operator=(), and unvirtualizedEraseChildren().

◆ _code_

DFSCode gum::prm::gspan::Pattern::_code_

private

The DFSCode of this Pattern.

Definition at line 222 of file pattern.h.

Referenced by code(), code(), and pop_back().

◆ _last_

LabelData* gum::prm::gspan::Pattern::_last_ = nullptr

private

The last LabelData added to this pattern.

Definition at line 233 of file pattern.h.

Referenced by Pattern(), addNodeWithLabel(), lastAdded(), and lastAdded().

◆ _node_map_

NodeProperty< LabelData* > gum::prm::gspan::Pattern::_node_map_

private

Mapping between nodes in this Pattern and their respective LabelData.

Definition at line 226 of file pattern.h.

Referenced by addArc(), addNodeWithLabel(), label(), label(), pop_back(), and remove().

◆ _parents_

NodeProperty< NodeSet* > gum::ArcGraphPart::_parents_

privateinherited

for each arc, the sets of its parents

Definition at line 284 of file arcGraphPart.h.

Referenced by ArcGraphPart(), ArcGraphPart(), _checkParents_(), addArc(), clearArcs(), eraseArc(), eraseParents(), existsArc(), operator=(), operator=(), parents(), and unvirtualizedEraseParents().

◆ onArcAdded

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

inherited

Definition at line 102 of file arcGraphPart.h.

Referenced by ArcGraphPart(), addArc(), operator=(), and operator=().

◆ onArcDeleted

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

inherited

Definition at line 103 of file arcGraphPart.h.

Referenced by clearArcs(), and eraseArc().

◆ onNodeAdded

Signaler< NodeId > gum::NodeGraphPart::onNodeAdded

inherited

Definition at line 281 of file nodeGraphPart.h.

Referenced by addNode(), and addNodeWithId().

◆ onNodeDeleted

Signaler< NodeId > gum::NodeGraphPart::onNodeDeleted

inherited

Definition at line 282 of file nodeGraphPart.h.

Referenced by _clearNodes_(), and eraseNode().

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

agrum/PRM/gspan/pattern.h
agrum/PRM/gspan/pattern.cpp
agrum/PRM/gspan/pattern_inl.h

Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ArcIterator

◆ node_const_iterator

◆ node_const_iterator_safe

◆ node_iterator

◆ node_iterator_safe

◆ NodeConstIterator

◆ NodeConstIteratorSafe

◆ NodeIterator

◆ NodeIteratorSafe

Constructor & Destructor Documentation

◆ Pattern() [1/2]

◆ Pattern() [2/2]

◆ ~Pattern()

Member Function Documentation

◆ _checkChildren_()

◆ _checkParents_()

◆ _expandCodeIsMinimal_()

◆ _not_rec_()

◆ _rec_()

◆ addArc() [1/2]

◆ addArc() [2/2]

◆ addNode()

◆ addNodes()

◆ addNodeWithId()

◆ addNodeWithLabel()

◆ ancestors()

◆ arcs()

◆ arcsProperty() [1/2]

◆ arcsProperty() [2/2]

◆ asNodeSet()

◆ begin()

◆ beginSafe()

◆ bound()

◆ children() [1/2]

◆ children() [2/2]

◆ clear()

◆ clearArcs()

◆ clearNodes()

◆ code() [1/2]

◆ code() [2/2]

◆ completeGraph()

◆ connectedComponents()

◆ descendants()

◆ directedPath()

◆ directedUnorientedPath()

◆ dotNodeLabel()

◆ edgeCode() [1/4]

◆ edgeCode() [2/4]

◆ edgeCode() [3/4]

◆ edgeCode() [4/4]

◆ empty()

◆ emptyArcs()

◆ emptyNodes()

◆ end()

◆ endSafe()

◆ eraseArc()

◆ eraseChildren()

◆ eraseNode()

◆ eraseParents()

◆ eraseSetOfArcs_()

◆ exists() [1/2]

◆ exists() [2/2]

◆ existsArc() [1/2]

◆ existsArc() [2/2]

◆ existsNode()

◆ family() [1/2]

◆ family() [2/2]

◆ hasDirectedPath()

◆ hasName()

◆ idFromName()

◆ isMinimal()

◆ label() [1/6]

◆ label() [2/6]