Base class for partially directed acyclic graphs. More...

#include <PDAG.h>

Inheritance diagram for gum::PDAG:

Collaboration diagram for gum::PDAG:

Public Types
using	NodeIterator = NodeGraphPartIterator
using	NodeConstIterator = NodeGraphPartIterator
using	NodeIteratorSafe = NodeGraphPartIteratorSafe
using	NodeConstIteratorSafe = NodeGraphPartIteratorSafe
using	EdgeIterator = EdgeSetIterator
using	ArcIterator = ArcSetIterator

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

Public Member Functions

void addEdge (NodeId first, NodeId second) final

insert a new edge into the partially directed graph

UndiGraph moralGraph () const

build a UndiGraph by moralizing the PDAG

UndiGraph moralizedAncestralGraph (const NodeSet &nodes) const

build a UndiGraph by moralizing the Ancestral Graph of a set of Nodes

bool hasMixedReallyOrientedPath (NodeId n1, NodeId n2) const

returns true if a mixed edge/directed arc path from node1 to node2 in the arc/edge set exists with at least one arc in the path (undirected path are not OK).

bool cSeparation (NodeId X, NodeId Y, const NodeSet &Z) const

check if node X and node Y are independent given nodes Z (in the sense of c-separation)

bool cSeparation (const NodeSet &X, const NodeSet &Y, const NodeSet &Z) const

check if nodes X and nodes Y are independent given Z (in the sense of d-separation)

std::string toDot () const override

to friendly display mixed graph in DOT format

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

Constructors / Destructors

PDAG (Size nodes_size=HashTableConst::default_size, bool nodes_resize_policy=true, Size arcs_size=HashTableConst::default_size, bool arcs_resize_policy=true, Size edges_size=HashTableConst::default_size, bool edges_resize_policy=true)

default constructor

PDAG (const UndiGraph &g)

default constructor

PDAG (const DAG &g)

default constructor

PDAG (const MixedGraph &g)

default constructor

PDAG (const PDAG &g)

copy constructor

PDAG (PDAG &&g)

move constructor

~PDAG () override

destructor

Operators

PDAG & operator= (const PDAG &g)

copy operator

PDAG & operator= (PDAG &&g)

move assignment operator

Accessors/Modifiers

void addArc (NodeId tail, NodeId head) final

insert a new arc into the directed graph

Operators

bool operator== (const MixedGraph &g) const

tests whether two MixedGraphs are identical (same nodes, arcs and edges)

Operators

bool operator== (const UndiGraph &g) const

tests whether two UndiGraphs are identical (same nodes, same edges)

Operators

bool operator== (const EdgeGraphPart &p) const

tests whether two EdgeGraphParts contain the same edges

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

Operators

bool operator== (const NodeGraphPart &p) const

check whether two NodeGraphParts contain the same nodes

Accessors/Modifiers

void eraseNode (const NodeId node) override

remove a node as well as its adjacent arcs and edges from the graph

void clear () override

removes all the nodes, arcs and edges from the graph

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

returns a mixed edge/directed arc path from node1 to node2 in the arc/edge set

bool hasMixedOrientedPath (NodeId node1, NodeId node2) const

returns true if a mixed edge/directed arc path from node1 to node2 in the arc/edge set exists.

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

returns a mixed/directed path from node1 to node2 in the arc/edge set

std::string toString () const override

to friendly display the content of the MixedGraph

NodeSet boundary (NodeId node) const

returns the set of node adjacent to a given node

NodeSet chainComponent (NodeId node) const

returns the set of nodes reachable by undirected path

NodeProperty< NodeId > chainComponents () const

returns a property {node:id of chain component} (edges only)

NodeProperty< NodeId > connectedComponents () const

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

Accessors/Modifiers

bool hasUndirectedCycle () const

checks whether the graph contains cycles

virtual UndiGraph partialUndiGraph (NodeSet nodes)

returns the partial graph formed by the nodes given in parameter

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

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

bool hasUndirectedPath (NodeId n1, NodeId n2) const

returns true if n1 and n2 are connected by an undirected path

bool hasUndirectedPath (NodeId n1, NodeId n2, const NodeSet &except) const

returns true if n1 and n2 are connected by a path avoiding nodes in except

bool hasUndirectedPath (const NodeSet &n1, const NodeSet &n2, const NodeSet &except) const

returns true if any node in n1 reaches any node in n2 avoiding except

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 exists (const NodeId id) const

alias for existsNode

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

Size size () const

alias for sizeNodes

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

const NodeGraphPart & nodes () const

return *this as a 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))

Accessors/Modifiers

virtual void eraseEdge (const Edge &edge)

removes an edge from the EdgeGraphPart

bool existsEdge (const Edge &edge) const

indicates whether a given edge exists

bool existsEdge (NodeId n1, NodeId n2) const

indicates whether a given edge exists

bool emptyEdges () const

indicates wether the EdgeGraphPart contains any edge

virtual void clearEdges ()

removes all the edges from the EdgeGraphPart

Size sizeEdges () const

indicates the number of edges stored within the EdgeGraphPart

const EdgeSet & edges () const

returns the set of edges stored within the EdgeGraphPart

const NodeSet & neighbours (NodeId id) const

returns the set of node neighbours to a given node

void eraseNeighbours (NodeId id)

erase all the edges adjacent to a given node

void unvirtualizedEraseNeighbours (NodeId id)

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

template<typename VAL>

EdgeProperty< VAL > edgesProperty (VAL(*f)(const Edge &), Size size=0) const

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

template<typename VAL>

EdgeProperty< VAL > edgesProperty (const VAL &val, Size size=0) const

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

template<typename VAL>

List< VAL > listMapEdges (VAL(*f)(const Edge &)) const

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

Accessors/Modifiers

tests whether two DiGraphs are different

Parameters

g	the DiGraph with which "this" is compared

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

Size sizeArcs () const

indicates the number of arcs stored within the ArcGraphPart

const ArcSet & arcs () const

returns the set of arcs stored within 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))

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

Public Attributes
Signaler< NodeId >	onNodeAdded
Signaler< NodeId >	onNodeDeleted
Signaler< NodeId, NodeId >	onEdgeAdded
Signaler< NodeId, NodeId >	onEdgeDeleted
Signaler< NodeId, NodeId >	onArcAdded
Signaler< NodeId, NodeId >	onArcDeleted

Protected Member Functions
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

Private Member Functions
void	_checkNeighbours_ (NodeId id)
	when the EdgeGraphPart contains no edge adjacent to a given node, this function adds an empty set entry to neighbours[id]
void	_clearEdges_ ()
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]

Private Attributes
EdgeSet	_edges_
	the set of all the edges contained within the EdgeGraphPart
NodeProperty< NodeSet * >	_neighbours_
	for each node, the set of its adjacent edges
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

Detailed Description

Base class for partially directed acyclic graphs.

This is the base class for partially directed acyclic graph : addArc and addEdge may throw a DirectedCycle if any (directed) cycle is created by this arc/edge.

exemple de code: // creating empty graphs

gum::PDAG g1,g2;

// adding nodes and arcs to g1

gum::NodeId i1=g1.addNode();

gum::NodeId i2=g1.addNode();

gum::NodeId i3=g1.addNode();

g1.addArc( i1,i2 );

g1.addArc( i1,i3 );

g1.addEdge( i2,i3 );

//throw an InvalidNode

// g1.addArc( i1+i2+i3,i1 );

// throw an InvalidCycle

// g1.addArc( i3,i1 );

*

// copying graphs

gum::PDAG g3 = g1;

g2 = g1;

gum::PDAG g4=g1;

// check if a graph has no node

if ( g1.empty() ) cerr << "graph g1 is empty" << endl;

// remove all the nodes (as well as their adjacent arcs)

g1.clear();

// remove some arc

g4.eraseArc( Arc ( i1,i3 ) );

// remove some edge

g4.eraseEdge( Edge ( i1,i3 ) );

// remove node

g2.eraseNode( i2 );

// parse a graph

for ( const auto node : g3.nodes() ) // type of node = gum::NodeId

cerr << node << endl;

for ( const auto& arc= g3.arcs()) // type of arc : gum::Arc&

cerr << iter << endl;

for ( const auto& arc= g3.edge()) // type of edge : gum::Edge&

cerr << iter << endl;

for ( const auto node :g3.parents( gum::NodeId(3) ))

cerr << " - "<<*iter;

for ( const auto node :g3.neighbours( gum::NodeId(3) ))

cerr << " - "<<*iter;

cerr<<endl;

// remove all the arcs that are parent of a given node

g3.eraseParents( gum::NodeId(2) );

gum::ArcGraphPart::parents
const NodeSet & parents(NodeId id) const
returns the set of nodes with arc ingoing to a given node
Definition arcGraphPart_inl.h:76

gum::ArcGraphPart::eraseParents
void eraseParents(NodeId id)
erase all the parents of a given node
Definition arcGraphPart_inl.h:132

gum::ArcGraphPart::eraseArc
virtual void eraseArc(const Arc &arc)
removes an arc from the ArcGraphPart
Definition arcGraphPart_inl.h:114

gum::ArcGraphPart::arcs
const ArcSet & arcs() const
returns the set of arcs stored within the ArcGraphPart
Definition arcGraphPart_inl.h:60

gum::Arc
The base class for all directed edges.
Definition graphElements.h:267

gum::EdgeGraphPart::eraseEdge
virtual void eraseEdge(const Edge &edge)
removes an edge from the EdgeGraphPart
Definition edgeGraphPart_inl.h:83

gum::EdgeGraphPart::neighbours
const NodeSet & neighbours(NodeId id) const
returns the set of node neighbours to a given node
Definition edgeGraphPart_inl.h:97

gum::Edge
The base class for all undirected edges.
Definition graphElements.h:164

gum::MixedGraph::eraseNode
void eraseNode(const NodeId node) override
remove a node as well as its adjacent arcs and edges from the graph
Definition mixedGraph_inl.h:91

gum::MixedGraph::clear
void clear() override
removes all the nodes, arcs and edges from the graph
Definition mixedGraph_inl.h:85

gum::NodeGraphPart::nodes
const NodeGraphPart & nodes() const
return *this as a NodeGraphPart
Definition nodeGraphPart_inl.h:379

gum::NodeGraphPart::empty
bool empty() const
alias for emptyNodes
Definition nodeGraphPart_inl.h:321

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

gum::PDAG
Base class for partially directed acyclic graphs.
Definition PDAG.h:130

gum::PDAG::addEdge
void addEdge(NodeId first, NodeId second) final
insert a new edge into the partially directed graph
Definition PDAG_inl.h:93

gum::PDAG::addArc
void addArc(NodeId tail, NodeId head) final
insert a new arc into the directed graph
Definition PDAG_inl.h:75

gum::NodeId
Size NodeId
Type for node ids.
Definition graphElements.h:117

Definition at line 130 of file PDAG.h.

Member Typedef Documentation

◆ ArcIterator

using gum::ArcGraphPart::ArcIterator = ArcSetIterator

inherited

Definition at line 100 of file arcGraphPart.h.

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

◆ PDAG() [1/6]

gum::PDAG::PDAG	(	Size	nodes_size = HashTableConst::default_size,
		bool	nodes_resize_policy = true,
		Size	arcs_size = HashTableConst::default_size,
		bool	arcs_resize_policy = true,
		Size	edges_size = HashTableConst::default_size,
		bool	edges_resize_policy = true )

default constructor

Parameters

nodes_size	the size of the hash table used to store all the nodes
nodes_resize_policy	the resizing policy of this hash table
arcs_size	the size of the hash table used to store all the arcs
arcs_resize_policy	the resizing policy of this hash table.

Definition at line 59 of file PDAG.cpp.

                                       :
      NodeGraphPart(nodes_size, nodes_resize_policy), MixedGraph(nodes_size,
                                                                 nodes_resize_policy,
                                                                 arcs_size,
                                                                 arcs_resize_policy,
                                                                 edges_size,
                                                                 edges_resize_policy) {
    GUM_CONSTRUCTOR(PDAG);
  }

References gum::MixedGraph::MixedGraph(), and PDAG().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PDAG() [2/6]

gum::PDAG::PDAG ( const UndiGraph & g )

explicit

default constructor

Parameters

nodes_size	the size of the hash table used to store all the nodes
nodes_resize_policy	the resizing policy of this hash table
arcs_size	the size of the hash table used to store all the arcs
arcs_resize_policy	the resizing policy of this hash table.

Definition at line 74 of file PDAG.cpp.

74: NodeGraphPart(g), MixedGraph(g) { GUM_CONSTRUCTOR(PDAG); }

References gum::MixedGraph::MixedGraph(), and PDAG().

Here is the call graph for this function:

◆ PDAG() [3/6]

gum::PDAG::PDAG ( const DAG & g )

explicit

default constructor

Parameters

nodes_size	the size of the hash table used to store all the nodes
nodes_resize_policy	the resizing policy of this hash table
arcs_size	the size of the hash table used to store all the arcs
arcs_resize_policy	the resizing policy of this hash table.

Definition at line 76 of file PDAG.cpp.

76: NodeGraphPart(g), MixedGraph(g) { GUM_CONSTRUCTOR(PDAG); }

References gum::MixedGraph::MixedGraph(), and PDAG().

Here is the call graph for this function:

◆ PDAG() [4/6]

gum::PDAG::PDAG ( const MixedGraph & g )

explicit

default constructor

Parameters

nodes_size	the size of the hash table used to store all the nodes
nodes_resize_policy	the resizing policy of this hash table
arcs_size	the size of the hash table used to store all the arcs
arcs_resize_policy	the resizing policy of this hash table.

Definition at line 78 of file PDAG.cpp.

78: NodeGraphPart(g), MixedGraph(g) { GUM_CONS_CPY(PDAG); }

References gum::MixedGraph::MixedGraph(), and PDAG().

Here is the call graph for this function:

◆ PDAG() [5/6]

gum::PDAG::PDAG ( const PDAG & g )

copy constructor

Parameters

g	the PDAG to copy

Definition at line 80 of file PDAG.cpp.

80: NodeGraphPart(g), MixedGraph(g) { GUM_CONS_CPY(PDAG); }

References gum::MixedGraph::MixedGraph(), and PDAG().

Here is the call graph for this function:

◆ PDAG() [6/6]

gum::PDAG::PDAG ( PDAG && g )

move constructor

Definition at line 82 of file PDAG.cpp.

                     : NodeGraphPart(std::move(g)), MixedGraph(std::move(g)) {
    GUM_CONS_MOV(PDAG);
  }

References gum::MixedGraph::MixedGraph(), and PDAG().

Here is the call graph for this function:

◆ ~PDAG()

gum::PDAG::~PDAG ( )

override

destructor

Definition at line 86 of file PDAG.cpp.

86{ GUM_DESTRUCTOR(PDAG); }

References PDAG().

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:

◆ _checkNeighbours_()

INLINE void gum::EdgeGraphPart::_checkNeighbours_ ( NodeId id )

privateinherited

when the EdgeGraphPart contains no edge adjacent to a given node, this function adds an empty set entry to neighbours[id]

Parameters

id	the node whose neighbours[id] is checked

Definition at line 68 of file edgeGraphPart_inl.h.

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

References _neighbours_.

Referenced by addEdge().

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:

◆ _clearEdges_()

void gum::EdgeGraphPart::_clearEdges_ ( )

privateinherited

Definition at line 93 of file edgeGraphPart.cpp.

                                   {
    for (const auto& elt: _neighbours_)
      delete elt.second;
 
    _neighbours_.clear();
 
    if (onEdgeDeleted.hasListener()) {
      EdgeSet tmp = _edges_;
      _edges_.clear();
 
      for (const auto& edge: tmp)
        GUM_EMIT2(onEdgeDeleted, edge.first(), edge.second());
    } else {
      _edges_.clear();
    }
  }

References _edges_, _neighbours_, GUM_EMIT2, and onEdgeDeleted.

Referenced by ~EdgeGraphPart(), and clearEdges().

Here is the caller graph for this function:

◆ addArc()

INLINE void gum::PDAG::addArc	(	NodeId	tail,
		NodeId	head )

finalvirtual

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
InvalidMixedCycle	if any (mixed) cycle is created by this arc.

Warning: Unfortunately, this means that addArc is not in constant time anymore.

Reimplemented from gum::DiGraph.

Definition at line 75 of file PDAG_inl.h.

                                                               {
    if (head == tail) {
      GUM_ERROR(InvalidDirectedCycle, "Add a mono-cycle in a PDAG for node " << head)
    }
    if (this->hasDirectedPath(head, tail)) {
      GUM_ERROR(InvalidDirectedCycle,
                "Add a directed cycle in a PDAG : between " << head << " and " << tail)
    }
    if (this->hasMixedReallyOrientedPath(head, tail)) {
      GUM_ERROR(InvalidPartiallyDirectedCycle,
                "Add a partial directed cycle in a PDAG : between " << head << " and " << tail)
    }
 
    // checking whether tail and head do belong to the graph is performed
    // within class DiGraph
    MixedGraph::addArc(tail, head);
  }

References gum::DiGraph::addArc(), GUM_ERROR, gum::DiGraph::hasDirectedPath(), and hasMixedReallyOrientedPath().

Referenced by gum::MeekRules::propagateToCPDAG().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addEdge()

INLINE void gum::PDAG::addEdge	(	NodeId	first,
		NodeId	second )

finalvirtual

insert a new edge into the partially directed graph

Parameters

first	the id of the first node of the new inserted edge
second	the id of the second node of the new inserted edge

Warning: if the edge already exists, nothing is done. In particular, no exception is raised.

Exceptions

InvalidNode	if first or second does not belong to the graph nodes
InvalidMixedCycle	if any (mixed) cycle is created by this edge.

Warning: Unfortunately, this means that addEdge is not in constant time anymore.

Reimplemented from gum::EdgeGraphPart.

Definition at line 93 of file PDAG_inl.h.

                                                                {
    if (head == tail) { GUM_ERROR(InvalidDirectedCycle, "Add a mono-cycle in a PDAG !") }
 
    if (this->hasMixedReallyOrientedPath(head, tail)
        || this->hasMixedReallyOrientedPath(tail, head)) {
      GUM_ERROR(InvalidPartiallyDirectedCycle,
                "Add a partial directed cycle in a PDAG : between " << head << " and " << tail)
    }
 
    // checking whether tail and head do belong to the graph is performed
    // within class DiGraph
    MixedGraph::addEdge(tail, head);
  }

References gum::EdgeGraphPart::addEdge(), GUM_ERROR, and hasMixedReallyOrientedPath().

Referenced by gum::MeekRules::propagateToCPDAG().

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::graph::moralGraph(), gum::graph::moralizedAncestralGraph(), 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:

◆ 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::ArcGraphPart::arcs ( ) const

inherited

returns the set of arcs stored within the ArcGraphPart

Definition at line 60 of file arcGraphPart_inl.h.

60{ return _arcs_; }

gum::ArcGraphPart::_arcs_

Set< Arc > _arcs_

the set of all the arcs contained within the ArcGraphPart

Definition arcGraphPart.h:281

References _arcs_.

Referenced by gum::EssentialGraph::_buildEssentialGraph_(), gum::prm::PRMClass< GUM_SCALAR >::_inheritClass_(), gum::prm::ClassBayesNet< GUM_SCALAR >::_init_(), gum::prm::gspan::Pattern::arcs(), gum::learning::FCI::learnPAG(), gum::learning::SimpleMiic::learnStructure(), and gum::DiGraph::toDot().

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

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:

◆ boundary()

INLINE NodeSet gum::MixedGraph::boundary ( NodeId node ) const

inherited

returns the set of node adjacent to a given node

Note that the set of node returned may be empty.

Parameters

id	the node to which the edges are adjacent

Definition at line 103 of file mixedGraph_inl.h.

103{ return graph::boundary(*this, node); }

gum::graph::boundary

NodeSet boundary(const G &g, NodeId node)

Returns the boundary of node: neighbours ∪ parents ∪ children.

Definition reachability_tpl.h:195

References gum::graph::boundary().

Here is the call graph for this function:

◆ chainComponent()

INLINE NodeSet gum::MixedGraph::chainComponent ( NodeId node ) const

inherited

returns the set of nodes reachable by undirected path

Note that the set of node returned may be empty.

Parameters

id	the node to which the edges are adjacent

Definition at line 105 of file mixedGraph_inl.h.

                                                             {
    return graph::chainComponent(*this, node);
  }

References gum::graph::chainComponent().

Referenced by gum::PDAG::toDot().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ chainComponents()

INLINE NodeProperty< NodeId > gum::MixedGraph::chainComponents ( ) const

inherited

returns a property {node:id of chain component} (edges only)

Definition at line 123 of file mixedGraph_inl.h.

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

References gum::graph::chainComponents().

Here is the call 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::MixedGraph::clear ( )

overridevirtualinherited

removes all the nodes, arcs and edges from the graph

Reimplemented from gum::NodeGraphPart.

Definition at line 85 of file mixedGraph_inl.h.

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

References gum::ArcGraphPart::clearArcs(), gum::EdgeGraphPart::clearEdges(), and gum::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 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:

◆ clearEdges()

void gum::EdgeGraphPart::clearEdges ( )

virtualinherited

removes all the edges from the EdgeGraphPart

Reimplemented in gum::CliqueGraph, and gum::PAG.

Definition at line 91 of file edgeGraphPart.cpp.

91{ _clearEdges_(); }

gum::EdgeGraphPart::_clearEdges_

void _clearEdges_()

Definition edgeGraphPart.cpp:93

References _clearEdges_().

Referenced by gum::MixedGraph::clear(), gum::UndiGraph::clear(), gum::PAG::clearEdges(), operator=(), operator=(), and gum::MixedGraph::operator=().

Here is the call graph for this function:

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:

◆ completeGraph() [1/2]

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:

◆ completeGraph() [2/2]

UndiGraph gum::UndiGraph::completeGraph ( int n )

staticinherited

create a complete UndiGraph with n nodes

Parameters

n int

Returns: the complete UndiGraph

Definition at line 61 of file undiGraph.cpp.

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

References UndiGraph(), addEdge(), and gum::NodeGraphPart::addNodes().

Here is the call graph for this function:

◆ connectedComponents()

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

inherited

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

Definition at line 127 of file mixedGraph_inl.h.

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

References gum::graph::connectedComponents().

Here is the call graph for this function:

◆ cSeparation() [1/2]

bool gum::PDAG::cSeparation	(	const NodeSet &	X,
		const NodeSet &	Y,
		const NodeSet &	Z ) const

check if nodes X and nodes Y are independent given Z (in the sense of d-separation)

Warning: cSeparation can be defined for PDAG but may seem relevant only for chainGraph (PDAG with no partially directed cycle)

Definition at line 125 of file PDAG.cpp.

                                                                                   {
    return graph::cSeparated(*this, X, Y, Z);
  }

References gum::graph::cSeparated().

Here is the call graph for this function:

◆ cSeparation() [2/2]

bool gum::PDAG::cSeparation	(	NodeId	X,
		NodeId	Y,
		const NodeSet &	Z ) const

check if node X and node Y are independent given nodes Z (in the sense of c-separation)

Warning: cSeparation can be defined for PDAG but may seem relevant only for ChainGraph (PDAG with no partially directed cycle)

Definition at line 121 of file PDAG.cpp.

                                                                   {
    return graph::cSeparated(*this, X, Y, Z);
  }

References gum::graph::cSeparated().

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:

◆ edges()

INLINE const EdgeSet & gum::EdgeGraphPart::edges ( ) const

inherited

returns the set of edges stored within the EdgeGraphPart

Definition at line 60 of file edgeGraphPart_inl.h.

60{ return _edges_; }

References _edges_.

Referenced by gum::EssentialGraph::_buildEssentialGraph_(), gum::MeekRules::_propagatesOrientationInChainOfRemainingEdges_(), gum::BarrenNodesFinder::barrenNodes(), gum::learning::ConstraintBasedLearning::initGraph_(), gum::learning::FCI::learnPAG(), gum::learning::FCI::possibleDSepPhase_(), gum::learning::SimpleMiic::propagatesOrientationInChainOfRemainingEdges_(), gum::PAG::reorientAllWith(), gum::learning::IBNLearner::setPossibleSkeleton(), gum::PAG::toDot(), gum::PAG::toMixedGraph(), and gum::PAG::toString().

Here is the caller graph for this function:

◆ edgesProperty() [1/2]

template<typename VAL>

EdgeProperty< VAL > gum::EdgeGraphPart::edgesProperty	(	const VAL &	val,
		Size	size = 0 ) const

inherited

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

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 edges. If you do not specify this parameter, the method will assign it for you.

◆ edgesProperty() [2/2]

template<typename VAL>

EdgeProperty< VAL > gum::EdgeGraphPart::edgesProperty	(	VAL(*	f )(const Edge &),
		Size	size = 0 ) const

inherited

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

Parameters

f	a function assigning a VAL to any edge
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 edges. If you do not specify this parameter, the method will assign it for you.

◆ 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_.

◆ emptyEdges()

INLINE bool gum::EdgeGraphPart::emptyEdges ( ) const

inherited

indicates wether the EdgeGraphPart contains any edge

Definition at line 56 of file edgeGraphPart_inl.h.

56{ return _edges_.empty(); }

References _edges_.

◆ 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(), gum::BayesNet< double >::changeVariableName(), eraseChildren(), eraseParents(), eraseSetOfArcs_(), gum::Separation::isBackdoorSeparated(), gum::learning::IBNLearner::learnDag_(), gum::learning::SimpleMiic::learnStructure(), gum::learning::ConstraintBasedLearning::orientDoubleHeadedArcs_(), gum::prm::gspan::Pattern::pop_back(), 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:

◆ eraseEdge()

INLINE void gum::EdgeGraphPart::eraseEdge ( const Edge & edge )

virtualinherited

removes an edge from the EdgeGraphPart

Parameters

edge	the edge to be removed

Warning: if the edge does not exist, nothing is done. In particular, no exception is thrown. However, the signal onEdgeDeleted is fired only if a node is effectively removed.

Reimplemented in gum::CliqueGraph, and gum::PAG.

Definition at line 83 of file edgeGraphPart_inl.h.

                                                       {
    if (existsEdge(edge)) {
      // ASSUMING first and second exists in  _neighbours_ (if not, it is an
      // error)
      NodeId id1 = edge.first();
      NodeId id2 = edge.second();
 
      _neighbours_[id1]->erase(id2);
      _neighbours_[id2]->erase(id1);
      _edges_.erase(edge);
      GUM_EMIT2(onEdgeDeleted, id1, id2);
    }
  }

References _edges_, _neighbours_, existsEdge(), gum::Edge::first(), GUM_EMIT2, onEdgeDeleted, and gum::Edge::second().

Referenced by gum::MeekRules::_propagatesOrientationInChainOfRemainingEdges_(), gum::PAG::eraseEdge(), eraseNeighbours(), gum::learning::SimpleMiic::learnPDAG(), gum::learning::SimpleMiic::learnStructure(), gum::learning::SimpleMiic::propagatesOrientationInChainOfRemainingEdges_(), and unvirtualizedEraseNeighbours().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ eraseNeighbours()

INLINE void gum::EdgeGraphPart::eraseNeighbours ( NodeId id )

inherited

erase all the edges adjacent to a given node

Parameters

id	the node the adjacent edges of which will be removed

Warning: if no edge is adjacent to id, nothing is done. In particular, no exception is thrown.; although this method is not virtual, it calls method eraseEdge( const Edge& edge ) and, as such, has a "virtual" behaviour

Definition at line 102 of file edgeGraphPart_inl.h.

                                                      {
    if (_neighbours_.exists(id)) {
      const NodeSet& set = *(_neighbours_[id]);
 
      for (auto iter = set.beginSafe(); iter != set.endSafe();
           ++iter) {   // safe iterator needed here
        // warning: use this erases so that you actually use the virtualized
        // edge removal function
        eraseEdge(Edge(*iter, id));
      }
    }
  }

References _neighbours_, gum::Set< Key >::beginSafe(), gum::Set< Key >::endSafe(), and eraseEdge().

Here is the call graph for this function:

◆ eraseNode()

INLINE void gum::MixedGraph::eraseNode ( const NodeId node )

overridevirtualinherited

remove a node as well as its adjacent arcs and edges 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.

Definition at line 91 of file mixedGraph_inl.h.

                                                     {
    EdgeGraphPart::unvirtualizedEraseNeighbours(node);
    ArcGraphPart::unvirtualizedEraseParents(node);
    ArcGraphPart::unvirtualizedEraseChildren(node);
    NodeGraphPart::eraseNode(node);
  }

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

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

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

inherited

alias for existsNode

Definition at line 307 of file nodeGraphPart_inl.h.

307{ return existsNode(node); }

gum::NodeGraphPart::existsNode

bool existsNode(const NodeId id) const

returns true iff the NodeGraphPart contains the given nodeId

Definition nodeGraphPart_inl.h:301

References existsNode().

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::_removeNode_(), gum::DiGraph::addArc(), gum::prm::gspan::Pattern::addArc(), gum::UndiGraph::addEdge(), gum::prm::gspan::Pattern::exists(), gum::learning::IBNLearner::learnDag_(), and populateNodesFromProperty().

Here is the call graph for this function:

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

◆ existsEdge() [1/2]

INLINE bool gum::EdgeGraphPart::existsEdge ( const Edge & edge ) const

inherited

indicates whether a given edge exists

Parameters

edge	the edge we test whether or not it belongs to the EdgeGraphPart

Definition at line 62 of file edgeGraphPart_inl.h.

62{ return _edges_.contains(edge); }

References _edges_.

Here is the caller graph for this function:

◆ existsEdge() [2/2]

INLINE bool gum::EdgeGraphPart::existsEdge	(	NodeId	n1,
		NodeId	n2 ) const

inherited

indicates whether a given edge exists

Parameters

n1	the id of one extremity of the edge we test the existence in the EdgeGraphPart
n2	the id of the other extremity of the edge we test the existence in the EdgeGraphPart

Definition at line 64 of file edgeGraphPart_inl.h.

                                                                         {
    return _neighbours_.exists(first) && _neighbours_[first]->exists(second);
  }

References _neighbours_.

◆ 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:

◆ hasMixedOrientedPath()

INLINE bool gum::MixedGraph::hasMixedOrientedPath	(	NodeId	node1,
		NodeId	node2 ) const

inherited

returns true if a mixed edge/directed arc path from node1 to node2 in the arc/edge set exists.

Parameters

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

Definition at line 114 of file mixedGraph_inl.h.

                                                                         {
    return graph::hasMixedOrientedPath(*this, n1, n2);
  }

References gum::graph::hasMixedOrientedPath().

Here is the call graph for this function:

◆ hasMixedReallyOrientedPath()

bool gum::PDAG::hasMixedReallyOrientedPath	(	gum::NodeId	n1,
		gum::NodeId	n2 ) const

returns true if a mixed edge/directed arc path from node1 to node2 in the arc/edge set exists with at least one arc in the path (undirected path are not OK).

Parameters

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

Definition at line 105 of file PDAG.cpp.

                                                                        {
    if (n1 == n2) return false;
    NodeSet marked;   // marked as already explored
    for (const auto nod: this->children(n1))
      if (rec_hasMixedReallyOrientedPath(*this, marked, nod, n2, true)) return true;
 
    for (const auto nod: this->neighbours(n1))
      if (rec_hasMixedReallyOrientedPath(*this, marked, nod, n2, false)) return true;
 
    return false;
  }

References gum::ArcGraphPart::children(), gum::EdgeGraphPart::neighbours(), and gum::rec_hasMixedReallyOrientedPath().

Referenced by addArc(), and addEdge().

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:

◆ hasUndirectedCycle()

INLINE bool gum::UndiGraph::hasUndirectedCycle ( ) const

inherited

checks whether the graph contains cycles

Definition at line 131 of file undiGraph_inl.h.

131{ return graph::hasUndirectedCycle(*this); }

gum::graph::hasUndirectedCycle

bool hasUndirectedCycle(const G &g)

Returns true if g contains at least one undirected cycle.

Definition cycleDetection_tpl.h:88

References gum::graph::hasUndirectedCycle().

Here is the call graph for this function:

◆ hasUndirectedPath() [1/3]

INLINE bool gum::UndiGraph::hasUndirectedPath	(	const NodeSet &	n1,
		const NodeSet &	n2,
		const NodeSet &	except ) const

inherited

returns true if any node in n1 reaches any node in n2 avoiding except

Definition at line 117 of file undiGraph_inl.h.

                                                                        {
    return graph::hasUndirectedPath(*this, n1, n2, except);
  }

References gum::graph::hasUndirectedPath().

Here is the call graph for this function:

◆ hasUndirectedPath() [2/3]

INLINE bool gum::UndiGraph::hasUndirectedPath	(	NodeId	n1,
		NodeId	n2 ) const

inherited

returns true if n1 and n2 are connected by an undirected path

Definition at line 109 of file undiGraph_inl.h.

                                                                     {
    return graph::hasUndirectedPath(*this, n1, n2);
  }

References gum::graph::hasUndirectedPath().

Here is the call graph for this function:

◆ hasUndirectedPath() [3/3]

INLINE bool gum::UndiGraph::hasUndirectedPath	(	NodeId	n1,
		NodeId	n2,
		const NodeSet &	except ) const

inherited

returns true if n1 and n2 are connected by a path avoiding nodes in except

n2 in except naturally leads to false

Definition at line 113 of file undiGraph_inl.h.

                                                                                            {
    return graph::hasUndirectedPath(*this, n1, n2, except);
  }

References gum::graph::hasUndirectedPath().

Here is the call 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:

◆ 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

◆ listMapEdges()

template<typename VAL>

List< VAL > gum::EdgeGraphPart::listMapEdges ( VAL(* f )(const Edge &) ) const

inherited

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

Parameters

f	a function assigning a VAL to any edge

◆ 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:

◆ mixedOrientedPath()

INLINE std::optional< std::vector< NodeId > > gum::MixedGraph::mixedOrientedPath	(	NodeId	node1,
		NodeId	node2 ) const

inherited

returns a mixed edge/directed arc path from node1 to node2 in the arc/edge set

This function returns, if any, a path from node1 to node2, using edges and/or arcs (wrt the direction of the arcs)

Parameters

node1	the id from which the path begins
node2	the id to which the path ends if no path can be found between the two nodes, returns std::nullopt

Definition at line 109 of file mixedGraph_inl.h.

                                                                                               {
    return graph::mixedOrientedPath(*this, n1, n2);
  }

References gum::graph::mixedOrientedPath().

Here is the call graph for this function:

◆ mixedUnorientedPath()

INLINE std::optional< std::vector< NodeId > > gum::MixedGraph::mixedUnorientedPath	(	NodeId	node1,
		NodeId	node2 ) const

inherited

returns a mixed/directed path from node1 to node2 in the arc/edge set

This function returns, if any, a path from node1 to node2, using edges and/or arcs (not necessarily following the direction of the arcs)

Parameters

node1	the id from which the path begins
node2	the id to which the path ends if no path can be found between the two nodes, returns std::nullopt.

Definition at line 118 of file mixedGraph_inl.h.

                                                                                                 {
    return graph::mixedUnorientedPath(*this, n1, n2);
  }

References gum::graph::mixedUnorientedPath().

Here is the call graph for this function:

◆ moralGraph()

UndiGraph gum::PDAG::moralGraph ( ) const

build a UndiGraph by moralizing the PDAG

Returns: the moralized graph

Definition at line 88 of file PDAG.cpp.

88{ return graph::moralGraph(*this); }

gum::graph::moralGraph

UndiGraph moralGraph(const G &g)

Returns the moral graph of g.

Definition moralization_tpl.h:60

References gum::graph::moralGraph().

Here is the call graph for this function:

◆ moralizedAncestralGraph()

UndiGraph gum::PDAG::moralizedAncestralGraph ( const NodeSet & nodes ) const

build a UndiGraph by moralizing the Ancestral Graph of a set of Nodes

Parameters

nodes the set of nodeId

Returns: the moralized ancestral graph

Definition at line 117 of file PDAG.cpp.

                                                                    {
    return graph::moralizedAncestralGraph(*this, nodes);
  }

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

Here is the call 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:

◆ neighbours()

INLINE const NodeSet & gum::EdgeGraphPart::neighbours ( NodeId id ) const

inherited

returns the set of node neighbours to a given node

Note that the set of nodes returned may be empty if no edge within the EdgeGraphPart is adjacent the given node.

Parameters

id	the node to which the edges are adjacent

Definition at line 97 of file edgeGraphPart_inl.h.

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

References _neighbours_, and gum::emptyNodeSet.

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

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::NodeGraphPart::nodes ( ) const

inherited

return *this as a NodeGraphPart

Definition at line 379 of file nodeGraphPart_inl.h.

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

References NodeGraphPart().

Here is the call 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/2]

INLINE PDAG & gum::PDAG::operator= ( const PDAG & g )

copy operator

Parameters

g	the PDAG to copy

Definition at line 57 of file PDAG_inl.h.

                                          {
    // avoid self assignment
    if (this != &g) {
      MixedGraph::operator=(g);
      GUM_OP_CPY(PDAG);
    }
 
    return *this;
  }

References PDAG(), and gum::MixedGraph::operator=().

Here is the call graph for this function:

◆ operator=() [2/2]

INLINE PDAG & gum::PDAG::operator= ( PDAG && g )

move assignment operator

Definition at line 67 of file PDAG_inl.h.

                                     {
    if (this != &g) {
      MixedGraph::operator=(std::move(g));
      GUM_OP_MOV(PDAG);
    }
    return *this;
  }

References PDAG(), and gum::MixedGraph::operator=().

Here is the call graph for this function:

◆ operator==() [1/6]

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/6]

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/6]

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

inherited

tests whether two EdgeGraphParts contain the same edges

Parameters

p	the EdgeGraphPart that we compare with this

Definition at line 126 of file edgeGraphPart_inl.h.

                                                                  {
    return _edges_ == p._edges_;
  }

References EdgeGraphPart(), and _edges_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator==() [4/6]

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

inherited

tests whether two MixedGraphs are identical (same nodes, arcs and edges)

Parameters

g	the MixedGraph with which "this" is compared

Definition at line 98 of file mixedGraph_inl.h.

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

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

Here is the call graph for this function:

◆ operator==() [5/6]

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:

◆ operator==() [6/6]

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

inherited

tests whether two UndiGraphs are identical (same nodes, same edges)

Parameters

g	the UndiGraph with which "this" is compared

Definition at line 100 of file undiGraph_inl.h.

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

References UndiGraph(), gum::EdgeGraphPart::operator==(), and gum::NodeGraphPart::operator==().

Here is the call 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().

◆ partialUndiGraph()

UndiGraph gum::UndiGraph::partialUndiGraph ( NodeSet nodes )

virtualinherited

returns the partial graph formed by the nodes given in parameter

Definition at line 127 of file undiGraph.cpp.

                                                     {
    UndiGraph partialGraph;
 
    for (const auto node: nodes) {
      partialGraph.addNodeWithId(node);
 
      for (const auto nei: neighbours(node))
        if (nodes.contains(nei) && partialGraph.existsNode(nei)) partialGraph.addEdge(node, nei);
    }
 
    return partialGraph;
  }

References UndiGraph(), addEdge(), gum::NodeGraphPart::addNodeWithId(), gum::NodeGraphPart::existsNode(), gum::EdgeGraphPart::neighbours(), and gum::NodeGraphPart::nodes().

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

◆ 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::NodeGraphPart::size ( ) const

inherited

alias for sizeNodes

Definition at line 299 of file nodeGraphPart_inl.h.

299{ return sizeNodes(); }

References sizeNodes().

Referenced by gum::StaticTriangulation::StaticTriangulation(), gum::prm::gspan::DFSTree< GUM_SCALAR >::_addChild_(), gum::StaticTriangulation::_triangulate_(), nodesPropertyFromFunction(), nodesPropertyFromVal(), populateNodesFromProperty(), gum::BayesBall::relevantTensors(), gum::dSeparationAlgorithm::relevantTensors(), gum::dSeparationAlgorithm::requisiteNodes(), gum::prm::gspan::Pattern::size(), and gum::UndiGraph::toDot().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sizeArcs()

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

inherited

indicates the number of arcs stored within the ArcGraphPart

Definition at line 58 of file arcGraphPart_inl.h.

58{ return _arcs_.size(); }

References _arcs_.

Referenced by gum::prm::gspan::Pattern::sizeArcs().

Here is the caller graph for this function:

◆ sizeEdges()

INLINE Size gum::EdgeGraphPart::sizeEdges ( ) const

inherited

indicates the number of edges stored within the EdgeGraphPart

Definition at line 58 of file edgeGraphPart_inl.h.

58{ return _edges_.size(); }

References _edges_.

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

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

overridevirtual

to friendly display mixed graph in DOT format

Reimplemented from gum::MixedGraph.

Definition at line 129 of file PDAG.cpp.

                              {
    std::string    output;
    List< NodeId > treatedNodes;
    output = "digraph \"no_name\" {\n";
 
    std::string tab = "  ";
    output += tab + "rankdir = TD;\n";
    output += tab + "node [style=filled,fillcolor=white,color=black];\n";
    output += tab + "graph [style=filled,color=\"#F5F5F5\"];\n";
 
    output += '\n';
    auto nodeDecl = [&](NodeId n) -> std::string { return std::to_string(n) + dotNodeLabel(n); };
 
    for (const auto node: nodes()) {
      if (neighbours(node).empty()) {
        output += tab + nodeDecl(node) + ";\n";
        treatedNodes.insert(node);
      }
    }
    output += '\n';
 
    int cluster = 0;
    for (const auto node: nodes()) {
      if (!treatedNodes.exists(node)) {
        output += tab + "subgraph cluster_" + std::to_string(cluster++) + "{{\n";
        output += tab + tab + "rank=same;\n" + tab + tab;
        for (const auto cc: chainComponent(node)) {
          output += nodeDecl(cc) + ';';
          treatedNodes.insert(cc);
        }
        output += '\n' + tab + "}}\n\n";
      }
    }
 
    for (const auto node: nodes()) {
      for (const auto child: children(node)) {
        output += std::format("{}{}->{};", tab, node, child);
        output += '\n';
      }
    }
    output += '\n' + tab + "edge [dir=none];\n";
 
    for (const auto node: nodes()) {
      for (const auto other: neighbours(node))
        if (other > node) {
          output += std::format("{}{}->{};", tab, node, other);
          output += '\n';
        }
    }
    output += "}\n";
    return output;
  }

References gum::MixedGraph::chainComponent(), gum::ArcGraphPart::children(), gum::NodeGraphPart::dotNodeLabel(), gum::NodeGraphPart::empty(), gum::List< Val >::exists(), gum::List< Val >::insert(), gum::EdgeGraphPart::neighbours(), and gum::NodeGraphPart::nodes().

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::MixedGraph::toString ( ) const

overridevirtualinherited

to friendly display the content of the MixedGraph

Reimplemented from gum::NodeGraphPart.

Definition at line 92 of file mixedGraph.cpp.

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

References gum::ArcGraphPart::toString(), gum::EdgeGraphPart::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:

◆ undirectedPath()

INLINE std::optional< std::vector< NodeId > > gum::UndiGraph::undirectedPath	(	NodeId	node1,
		NodeId	node2 ) const

inherited

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

Definition at line 104 of file undiGraph_inl.h.

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

References gum::graph::undirectedPath().

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

◆ unvirtualizedEraseNeighbours()

INLINE void gum::EdgeGraphPart::unvirtualizedEraseNeighbours ( NodeId id )

inherited

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

Parameters

id	the node whose ingoing arcs will be removed

Definition at line 115 of file edgeGraphPart_inl.h.

                                                                   {
    if (_neighbours_.exists(id)) {
      const NodeSet& set = *(_neighbours_[id]);
 
      for (auto iter = set.beginSafe(); iter != set.endSafe();
           ++iter) {   // safe iterator needed here
        EdgeGraphPart::eraseEdge(Edge(*iter, id));
      }
    }
  }

References _neighbours_, gum::Set< Key >::beginSafe(), gum::Set< Key >::endSafe(), and eraseEdge().

Referenced by gum::MixedGraph::eraseNode(), and gum::UndiGraph::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);
  }

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/base/graphs/PDAG.h
agrum/base/graphs/PDAG.cpp
agrum/base/graphs/PDAG_inl.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ArcIterator

◆ EdgeIterator

◆ node_const_iterator

◆ node_const_iterator_safe

◆ node_iterator

◆ node_iterator_safe

◆ NodeConstIterator

◆ NodeConstIteratorSafe

◆ NodeIterator

◆ NodeIteratorSafe

Constructor & Destructor Documentation

◆ PDAG() [1/6]

◆ PDAG() [2/6]

◆ PDAG() [3/6]

◆ PDAG() [4/6]

◆ PDAG() [5/6]

◆ PDAG() [6/6]

◆ ~PDAG()

Member Function Documentation

◆ _checkChildren_()

◆ _checkNeighbours_()

◆ _checkParents_()

◆ _clearEdges_()

◆ addArc()

◆ addEdge()

◆ addNode()

◆ addNodes()

◆ addNodeWithId()

◆ ancestors()

◆ arcs()

◆ arcsProperty() [1/2]

◆ arcsProperty() [2/2]

◆ asNodeSet()

◆ begin()

◆ beginSafe()

◆ bound()

◆ boundary()

◆ chainComponent()

◆ chainComponents()

◆ children() [1/2]

◆ children() [2/2]

◆ clear()

◆ clearArcs()

◆ clearEdges()

◆ clearNodes()

◆ completeGraph() [1/2]

◆ completeGraph() [2/2]

◆ connectedComponents()

◆ cSeparation() [1/2]

◆ cSeparation() [2/2]

◆ descendants()

◆ directedPath()

◆ directedUnorientedPath()

◆ dotNodeLabel()

◆ edges()

◆ edgesProperty() [1/2]

◆ edgesProperty() [2/2]

◆ empty()

◆ emptyArcs()

◆ emptyEdges()

◆ emptyNodes()

◆ end()

◆ endSafe()

◆ eraseArc()

◆ eraseChildren()

◆ eraseEdge()

◆ eraseNeighbours()

◆ eraseNode()

◆ eraseParents()

◆ eraseSetOfArcs_()

◆ exists()