gum::UndiGraph Class Reference

Base class for undirected graphs. More...

#include <undiGraph.h>

Inheritance diagram for gum::UndiGraph:

Collaboration diagram for gum::UndiGraph:

Public Types
using	NodeIterator = NodeGraphPartIterator
using	NodeConstIterator = NodeGraphPartIterator
using	NodeIteratorSafe = NodeGraphPartIteratorSafe
using	NodeConstIteratorSafe = NodeGraphPartIteratorSafe
using	EdgeIterator = EdgeSetIterator
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
Operators
UndiGraph &	operator= (const UndiGraph &g)
	copy operator
UndiGraph &	operator= (UndiGraph &&g)
	move assignment operator
bool	operator== (const UndiGraph &g) const
	tests whether two UndiGraphs are identical (same nodes, same edges)
Accessors/Modifiers
void	addEdge (NodeId first, NodeId second) override
	insert a new edge into the undirected graph
void	eraseNode (NodeId id) override
	remove a node and its adjacent edges from the graph
void	clear () override
	removes all the nodes and edges from the graph
std::string	toString () const override
	to friendly display the content of the graph
virtual std::string	toDot () const
	to friendly display graph in DOT format
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
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}
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
Operators
bool	operator== (const NodeGraphPart &p) const
	check whether two NodeGraphParts contain the same nodes
Accessors/Modifiers
void	populateNodes (const NodeGraphPart &s)
	populateNodes clears *this and fills it with the same nodes as "s"
template<typename T>
void	populateNodesFromProperty (const NodeProperty< T > &h)
	populateNodesFromProperty clears *this and fills it with the keys of "h"
NodeId	nextNodeId () const
	returns a new node id, not yet used by any node
virtual NodeId	addNode ()
	insert a new node and return its id
std::vector< NodeId >	addNodes (Size n)
	insert n nodes
virtual void	addNodeWithId (const NodeId id)
	try to insert a node with the given id
bool	existsNode (const NodeId id) const
	returns true iff the NodeGraphPart contains the given nodeId
bool	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))
Operators
bool	operator== (const EdgeGraphPart &p) const
	tests whether two EdgeGraphParts contain the same edges
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))

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

Private Member Functions
void	_updateEndIteratorSafe_ ()
	updating endIterator (always at max+1)
void	_clearNodes_ ()
	code for clearing nodes (called twice)
void	_eraseHole_ (NodeId id)
	to delete hole.
void	_addHole_ (NodeId id)
	to add a hole.
std::unique_ptr< Bijection< NodeId, std::string > >	_cloneNames_ () const
	clone the names bijection (returns nullptr when no name has been set)
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_ ()
Introspection
bool	_inHoles_ (NodeId id) const
Size	_sizeHoles_ () const

Private Attributes
NodeSet *	_holes_
	the set of nodes not contained in the NodeGraphPart in the interval 1.
std::unique_ptr< Bijection< NodeId, std::string > >	_names_
	optional node names — null when no name has been set
Size	_holes_size_
	value for holes configuration
bool	_holes_resize_policy_
	value for holes configuration
NodeGraphPartIteratorSafe	_endIteratorSafe_
	the end iterator (used to speed-up parsings of the NodeGraphPart)
NodeId	_boundVal_
	the id below which NodeIds may belong to the NodeGraphPart
EdgeSet	_edges_
	the set of all the edges contained within the EdgeGraphPart
NodeProperty< NodeSet * >	_neighbours_
	for each node, the set of its adjacent edges

Constructors / Destructors
	UndiGraph (Size nodes_size=HashTableConst::default_size, bool nodes_resize_policy=true, Size edges_size=HashTableConst::default_size, bool edges_resize_policy=true)
	default constructor
	UndiGraph (const UndiGraph &g)
	copy constructor
	UndiGraph (UndiGraph &&g)
	move constructor
	~UndiGraph () override
	destructor
static UndiGraph	completeGraph (int n)
	create a complete UndiGraph with n nodes

Detailed Description

Base class for undirected graphs.

This is the base class for graphs containing undirected edges (so-called edges).

Usage example:

// creating empty graphs
UndiGraph g1,g2;
 
// adding nodes and edges to g1
NodeId i1=g1.addNode();
NodeId i2=g1.addNode();
NodeId i3=g1.addNode();
g1.addEdge( i1,i2 );
g1.addEdge( i1,i3 );
g1.addEdge( i2,i3 );
 
//throw an InvalidNode
// g1.addEdge( i1+i2+i3,i1 );
 
// copying graphs
UndiGraph g3 = g1;
g2 = g1;
UndiGraph 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 edges)
g1.clear();
 
// remove some edge
g4.eraseEdge( Edge ( i1,i3 ) );
 
// remove node
g2.eraseNode( i2 );
 
// parse a graph
for ( const auto node : g3.nodes() )
  cerr << node << endl;
 
for ( const auto& edge : g3.edges())
  cerr << edge << endl;
 
const EdgeSet& a=g3.neighbours( 3 );
for ( const auto& edge : a)
  cerr << "  -  "<<edge;
 
cerr<<endl;
 
// remove all the edges that are adjacent to a given node
g3.eraseNeighbours( 2 );

Definition at line 130 of file undiGraph.h.

Member Typedef Documentation

EdgeIterator

using gum::EdgeGraphPart::EdgeIterator = EdgeSetIterator

inherited

Definition at line 96 of file edgeGraphPart.h.

node_const_iterator

using gum::NodeGraphPart::node_const_iterator = NodeGraphPartIterator

inherited

types for STL compliance

Definition at line 268 of file nodeGraphPart.h.

node_const_iterator_safe

using gum::NodeGraphPart::node_const_iterator_safe = NodeGraphPartIteratorSafe

inherited

types for STL compliance

Definition at line 270 of file nodeGraphPart.h.

node_iterator

using gum::NodeGraphPart::node_iterator = NodeGraphPartIterator

inherited

types for STL compliance

Definition at line 267 of file nodeGraphPart.h.

node_iterator_safe

using gum::NodeGraphPart::node_iterator_safe = NodeGraphPartIteratorSafe

inherited

types for STL compliance

Definition at line 269 of file nodeGraphPart.h.

NodeConstIterator

using gum::NodeGraphPart::NodeConstIterator = NodeGraphPartIterator

inherited

Definition at line 277 of file nodeGraphPart.h.

NodeConstIteratorSafe

using gum::NodeGraphPart::NodeConstIteratorSafe = NodeGraphPartIteratorSafe

inherited

Definition at line 279 of file nodeGraphPart.h.

NodeIterator

using gum::NodeGraphPart::NodeIterator = NodeGraphPartIterator

inherited

Definition at line 276 of file nodeGraphPart.h.

NodeIteratorSafe

using gum::NodeGraphPart::NodeIteratorSafe = NodeGraphPartIteratorSafe

inherited

Definition at line 278 of file nodeGraphPart.h.

Constructor & Destructor Documentation

UndiGraph() [1/3]

gum::UndiGraph::UndiGraph ( Size nodes_size = HashTableConst::default_size, bool nodes_resize_policy = true, Size edges_size = HashTableConst::default_size, bool edges_resize_policy = true )

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
edges_size	the size of the hash table used to store all the edges
edges_resize_policy	the resizing policy of this hash table

Definition at line 73 of file undiGraph.cpp.

                                                 :
      NodeGraphPart(nodes_size, nodes_resize_policy),
      EdgeGraphPart(edges_size, edges_resize_policy) {
    GUM_CONSTRUCTOR(UndiGraph);
  }

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

Referenced by gum::MixedGraph::MixedGraph(), gum::MixedGraph::MixedGraph(), gum::MixedGraph::MixedGraph(), gum::MixedGraph::MixedGraph(), gum::MixedGraph::MixedGraph(), gum::PAG::PAG(), gum::PAG::PAG(), UndiGraph(), UndiGraph(), UndiGraph(), ~UndiGraph(), completeGraph(), operator=(), operator=(), operator==(), and partialUndiGraph().

Here is the call graph for this function:

Here is the caller graph for this function:

UndiGraph() [2/3]

gum::UndiGraph::UndiGraph

(

const UndiGraph &

g

)

copy constructor

Parameters

g	the UndiGraph to copy

Definition at line 82 of file undiGraph.cpp.

                                         : NodeGraphPart(g), EdgeGraphPart(g) {
    GUM_CONS_CPY(UndiGraph);
  }

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

Here is the call graph for this function:

UndiGraph() [3/3]

gum::UndiGraph::UndiGraph

(

UndiGraph &&

g

)

move constructor

Definition at line 86 of file undiGraph.cpp.

                                    : NodeGraphPart(std::move(g)), EdgeGraphPart(std::move(g)) {
    GUM_CONS_MOV(UndiGraph);
  }

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

Here is the call graph for this function:

~UndiGraph()

gum::UndiGraph::~UndiGraph ( )

override

destructor

Definition at line 90 of file undiGraph.cpp.

                        {
    GUM_DESTRUCTOR(UndiGraph);
    ;
  }

References UndiGraph().

Here is the call graph for this function:

Member Function Documentation

_addHole_()

void gum::NodeGraphPart::_addHole_ ( NodeId id )

privateinherited

to add a hole.

Warning

id is assumed not to be already a hole

Definition at line 112 of file nodeGraphPart.cpp.

                                           {
    // we assume that the node exists
    if (node + 1 == _boundVal_) {
      // we remove the max : no new hole and maybe a bunch of holes to remove
      --_boundVal_;
 
      if (_holes_) {
        while (_holes_->contains(_boundVal_ - 1)) {
          // a bunch of holes to remove. We do not use inHoles for optimisation
          // :
          // not to repeat the test if ( _holes_) each time
          _holes_->erase(--_boundVal_);
        }
 
        if (_holes_->empty()) {
          delete _holes_;
          _holes_ = nullptr;
        }
      }
 
      _updateEndIteratorSafe_();
    } else {
      if (!_holes_) _holes_ = new NodeSet(_holes_size_, _holes_resize_policy_);
 
      _holes_->insert(node);
    }
  }

References _boundVal_, _holes_, _holes_resize_policy_, _holes_size_, and _updateEndIteratorSafe_().

Referenced by eraseNode(), and NodeGraphPartIteratorSafe.

Here is the call graph for this function:

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:

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

_clearNodes_()

void gum::NodeGraphPart::_clearNodes_ ( )

privateinherited

code for clearing nodes (called twice)

Definition at line 237 of file nodeGraphPart.cpp.

                                   {
    NodeId bound = _boundVal_;
    _boundVal_   = 0;
 
    if (onNodeDeleted.hasListener()) {
      for (NodeId n = 0; n < bound; ++n) {
        if (!_inHoles_(n)) GUM_EMIT1(onNodeDeleted, n);
      }
    }
 
    _updateEndIteratorSafe_();
 
    delete (_holes_);
    _holes_ = nullptr;
    _names_.reset();
  }

References _boundVal_, _holes_, _inHoles_(), _names_, _updateEndIteratorSafe_(), bound(), GUM_EMIT1, and onNodeDeleted.

Referenced by clear(), clearNodes(), and NodeGraphPartIteratorSafe.

Here is the call graph for this function:

Here is the caller graph for this function:

_cloneNames_()

INLINE std::unique_ptr< Bijection< NodeId, std::string > > gum::NodeGraphPart::_cloneNames_ ( ) const

privateinherited

clone the names bijection (returns nullptr when no name has been set)

Definition at line 389 of file nodeGraphPart_inl.h.

                                                                                           {
    return _names_ ? std::make_unique< Bijection< NodeId, std::string > >(*_names_) : nullptr;
  }

References _names_.

Referenced by NodeGraphPart(), and populateNodes().

Here is the caller graph for this function:

_eraseHole_()

INLINE void gum::NodeGraphPart::_eraseHole_ ( NodeId id )

privateinherited

to delete hole.

Warning

the hole is assumed to be existing.

Definition at line 255 of file nodeGraphPart_inl.h.

                                                  {
    _holes_->erase(id);
 
    if (_holes_->empty()) {
      delete _holes_;
      _holes_ = nullptr;
    }
  }

References _holes_.

Referenced by addNode(), addNodeWithId(), and NodeGraphPartIteratorSafe.

Here is the caller graph for this function:

_inHoles_()

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

privateinherited

Returns

true if id is part of holes

Definition at line 383 of file nodeGraphPart_inl.h.

{ return _holes_ && _holes_->contains(id); }

References _holes_.

Referenced by _clearNodes_(), addNodeWithId(), asNodeSet(), existsNode(), NodeGraphPartIteratorSafe, and toString().

Here is the caller graph for this function:

_sizeHoles_()

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

privateinherited

Returns

the size of holes

Definition at line 386 of file nodeGraphPart_inl.h.

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

References _holes_.

Referenced by NodeGraphPartIteratorSafe.

Here is the caller graph for this function:

_updateEndIteratorSafe_()

INLINE void gum::NodeGraphPart::_updateEndIteratorSafe_ ( )

privateinherited

updating endIterator (always at max+1)

Definition at line 340 of file nodeGraphPart_inl.h.

{ _endIteratorSafe_.setPos_(_boundVal_); }

References _boundVal_, and _endIteratorSafe_.

Referenced by NodeGraphPart(), NodeGraphPart(), NodeGraphPart(), _addHole_(), _clearNodes_(), addNode(), addNodeWithId(), NodeGraphPartIteratorSafe, operator=(), and populateNodes().

Here is the caller graph for this function:

addEdge()

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

overridevirtual

insert a new edge into the undirected graph

The order in which the extremal nodes are specified is not important.

Parameters

first	the id of one extremal node of the new inserted edge
second	the id of the other extremal 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 and/or second do not belong to the graph nodes

Reimplemented from gum::EdgeGraphPart.

Definition at line 59 of file undiGraph_inl.h.

                                                                        {
    if (!exists(first)) { GUM_ERROR(InvalidNode, "Node (" << first << ") does not exist.") }
 
    if (!exists(second)) { GUM_ERROR(InvalidNode, "Node (" << second << ") does not exist.") }
 
    EdgeGraphPart::addEdge(second, first);
  }

References gum::EdgeGraphPart::addEdge(), gum::NodeGraphPart::exists(), and GUM_ERROR.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::_addEdgesInReducedGraph_(), gum::EssentialGraph::_buildEssentialGraph_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_buildPatternGraph_(), gum::prm::StructuredInference< GUM_SCALAR >::_buildPatternGraph_(), gum::prm::GSpan< GUM_SCALAR >::_sortPatterns_(), gum::StaticTriangulation::_triangulate_(), gum::PAG::addEdge(), completeGraph(), gum::Separation::isForwardSeparated(), gum::graph::moralGraph(), gum::graph::moralizedAncestralGraph(), partialUndiGraph(), gum::learning::IBNLearner::prepareFCI_(), gum::learning::IBNLearner::prepareMiic_(), gum::learning::IBNLearner::preparePC_(), gum::EssentialGraph::skeleton(), and gum::PAG::toMixedGraph().

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:

asNodeSet()

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

inherited

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

Warning

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

for(const auto n : nodes()) 

rather than

for(const auto n : asNodeSet()) 

as this is faster and consumes much less memory.

Definition at line 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.

{ return _boundVal_; }

References _boundVal_.

Referenced by _clearNodes_(), and populateNodesFromProperty().

Here is the caller graph for this function:

chainComponents()

INLINE NodeProperty< NodeId > gum::UndiGraph::chainComponents

(

)

const

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

Definition at line 123 of file undiGraph_inl.h.

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

References gum::graph::chainComponents().

Here is the call graph for this function:

clear()

INLINE void gum::UndiGraph::clear ( )

overridevirtual

removes all the nodes and edges from the graph

Reimplemented from gum::NodeGraphPart.

Definition at line 67 of file undiGraph_inl.h.

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

References gum::EdgeGraphPart::clearEdges(), and gum::NodeGraphPart::clearNodes().

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

Here is the call graph for this function:

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.

{ _clearEdges_(); }

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.

{ _clearNodes_(); }

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

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

static

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

(

)

const

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

Definition at line 127 of file undiGraph_inl.h.

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

References gum::graph::connectedComponents().

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.

{ 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.

{ return emptyNodes(); }

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:

emptyEdges()

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

inherited

indicates wether the EdgeGraphPart contains any edge

Definition at line 56 of file edgeGraphPart_inl.h.

{ 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.

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

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::UndiGraph::eraseNode ( NodeId id )

overridevirtual

remove a node and its adjacent 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 92 of file undiGraph_inl.h.

                                                  {
    // warning: to remove the edges adjacent to id, use the unvirtualized
    // versions
    // of edge removals
    EdgeGraphPart::unvirtualizedEraseNeighbours(id);
    NodeGraphPart::eraseNode(id);
  }

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

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::_removeNode_(), gum::StaticTriangulation::_triangulate_(), and gum::PAG::eraseNode().

Here is the call graph for this function:

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

{ return existsNode(node); }

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:

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.

{ return _edges_.contains(edge); }

References _edges_.

Referenced by gum::prm::GSpan< GUM_SCALAR >::_sortPatterns_(), gum::EssentialGraph::_strongly_protected_(), gum::StaticTriangulation::_triangulate_(), gum::PAG::addEdge(), gum::learning::FCI::computePossibleDSep_(), eraseEdge(), gum::PAG::eraseEdge(), gum::Separation::isForwardSeparated(), gum::learning::FCI::learnPAG(), gum::learning::FCI::orientCollidersOnPAG_(), gum::learning::FCI::possibleDSepPhase_(), gum::learning::FCI::ruleR10_(), gum::learning::FCI::ruleR1_(), gum::learning::FCI::ruleR2_(), gum::learning::FCI::ruleR3_(), gum::learning::FCI::ruleR4_(), gum::learning::FCI::ruleR5_(), gum::learning::FCI::ruleR7_(), gum::learning::FCI::ruleR8_(), and gum::learning::FCI::ruleR9_().

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:

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.

{ 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

checks whether the graph contains cycles

Definition at line 131 of file undiGraph_inl.h.

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

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

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

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

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:

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:

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.

Referenced by gum::BinaryJoinTreeConverterDefault::_convertClique_(), gum::BinaryJoinTreeConverterDefault::_convertConnectedComponent_(), gum::BinaryJoinTreeConverterDefault::_markConnectedComponent_(), gum::MeekRules::_propagatesOrientationInChainOfRemainingEdges_(), gum::prm::StructuredInference< GUM_SCALAR >::_removeBarrenNodes_(), gum::prm::GSpan< GUM_SCALAR >::_sortPatterns_(), gum::prm::GSpan< GUM_SCALAR >::_subgraph_mining_(), gum::StaticTriangulation::_triangulate_(), gum::learning::FCI::computePossibleDSep_(), gum::PAG::eraseNode(), gum::PDAG::hasMixedReallyOrientedPath(), gum::learning::SimpleMiic::learnPDAG(), gum::learning::SimpleMiic::learnStructure(), gum::UndiGraph::partialUndiGraph(), gum::learning::SimpleMiic::propagatesOrientationInChainOfRemainingEdges_(), gum::rec_hasMixedReallyOrientedPath(), gum::learning::FCI::ruleR10_(), gum::learning::FCI::ruleR1_(), gum::learning::FCI::ruleR2_(), gum::learning::FCI::ruleR3_(), gum::learning::FCI::ruleR4_(), gum::learning::FCI::ruleR5_(), gum::learning::FCI::ruleR6_(), gum::learning::FCI::ruleR7_(), gum::learning::FCI::ruleR8_(), gum::learning::FCI::ruleR9_(), gum::MixedGraph::toDot(), gum::PDAG::toDot(), and gum::UndiGraph::toDot().

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

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

Referenced by gum::DoCalculus< GUM_SCALAR >::_ancestorsIn_(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::_generateClassDag_(), gum::prm::LayerGenerator< GUM_SCALAR >::_generateClassDag_(), gum::prm::ClassBayesNet< GUM_SCALAR >::_init_(), gum::prm::SVE< GUM_SCALAR >::_initElimOrder_(), gum::prm::SVED< GUM_SCALAR >::_initElimOrder_(), gum::prm::SVE< GUM_SCALAR >::_initLiftedNodes_(), gum::MeekRules::_orientDoubleHeadedArcs_(), gum::prm::GSpan< GUM_SCALAR >::_sortPatterns_(), gum::prm::PRMFactory< GUM_SCALAR >::addAttribute(), gum::DoorCriteria::enumerateBackdoorSets(), gum::learning::ConstraintBasedLearning::initGraph_(), gum::learning::FCI::learnPAG(), gum::DAG::moralizedAncestralGraph(), gum::graph::moralizedAncestralGraph(), gum::PDAG::moralizedAncestralGraph(), gum::prm::gspan::Pattern::nodes(), operator<<(), gum::learning::ConstraintBasedLearning::orientDoubleHeadedArcs_(), gum::UndiGraph::partialUndiGraph(), populateNodesFromProperty(), gum::learning::IBNLearner::prepareFCI_(), gum::learning::IBNLearner::prepareMiic_(), gum::learning::IBNLearner::preparePC_(), gum::learning::FCI::ruleR10_(), gum::learning::FCI::ruleR1_(), gum::learning::FCI::ruleR2_(), gum::learning::FCI::ruleR3_(), gum::learning::FCI::ruleR4_(), gum::learning::FCI::ruleR5_(), gum::learning::FCI::ruleR6_(), gum::learning::FCI::ruleR7_(), gum::learning::FCI::ruleR8_(), gum::learning::FCI::ruleR9_(), gum::DiGraph::toDot(), gum::MixedGraph::toDot(), gum::PAG::toDot(), gum::PDAG::toDot(), gum::UndiGraph::toDot(), and gum::PAG::toMixedGraph().

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 UndiGraph & gum::UndiGraph::operator=

(

const UndiGraph &

g

)

copy operator

Parameters

g	the DiGraph to copy

Definition at line 72 of file undiGraph_inl.h.

                                                         {
    if (this != &g) {
      UndiGraph::clear();
      NodeGraphPart::operator=(g);
      EdgeGraphPart::operator=(g);
      GUM_OP_CPY(UndiGraph);
    }
 
    return *this;
  }

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

Referenced by gum::PAG::operator=(), and gum::PAG::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [2/2]

INLINE UndiGraph & gum::UndiGraph::operator=

(

UndiGraph &&

g

)

move assignment operator

Definition at line 83 of file undiGraph_inl.h.

                                                    {
    if (this != &g) {
      NodeGraphPart::operator=(std::move(g));
      EdgeGraphPart::operator=(std::move(g));
      GUM_OP_MOV(UndiGraph);
    }
    return *this;
  }

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

Here is the call graph for this function:

operator==() [1/3]

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==() [2/3]

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

inherited

check whether two NodeGraphParts contain the same nodes

Parameters

p	the NodeGraphPart to be compared with "this"

Definition at line 356 of file nodeGraphPart_inl.h.

                                                                  {
    if (_boundVal_ != p._boundVal_) return false;
 
    if (_holes_)
      if (p._holes_) return (*_holes_ == *p._holes_);
      else return false;
    else if (p._holes_) return false;
 
    return true;
  }

References NodeGraphPart(), _boundVal_, and _holes_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

operator==() [3/3]

INLINE bool gum::UndiGraph::operator==

(

const UndiGraph &

g

)

const

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:

partialUndiGraph()

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

virtual

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.

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

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.

{ 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::UndiGraph::toDot ( ) const

virtual

to friendly display graph in DOT format

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

Definition at line 102 of file undiGraph.cpp.

                                   {
    std::stringstream output;
    std::stringstream nodeStream;
    std::stringstream edgeStream;
    List< NodeId >    treatedNodes;
    output << "digraph \"no_name\" {\nedge [dir=none]\n";
    nodeStream << "node [shape = ellipse];\n";
    std::string tab = "  ";
 
    for (const auto node: nodes()) {
      nodeStream << std::format("{}{}{};", tab, node, dotNodeLabel(node));
 
      if (neighbours(node).size() > 0)
        for (const auto nei: neighbours(node))
          if (!treatedNodes.exists(nei)) edgeStream << std::format("{}{} -> {};\n", tab, node, nei);
 
      treatedNodes.insert(node);
    }
 
    output << nodeStream.str() << '\n' << edgeStream.str() << '\n' << "}\n";
 
    return output.str();
  }

References gum::NodeGraphPart::dotNodeLabel(), gum::List< Val >::exists(), gum::List< Val >::insert(), gum::EdgeGraphPart::neighbours(), gum::NodeGraphPart::nodes(), and gum::NodeGraphPart::size().

Here is the call graph for this function:

toString()

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

overridevirtual

to friendly display the content of the graph

Reimplemented from gum::NodeGraphPart.

Definition at line 95 of file undiGraph.cpp.

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

References 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

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:

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:

Member Data Documentation

_boundVal_

NodeId gum::NodeGraphPart::_boundVal_

privateinherited

the id below which NodeIds may belong to the NodeGraphPart

Definition at line 540 of file nodeGraphPart.h.

Referenced by NodeGraphPart(), NodeGraphPart(), NodeGraphPart(), _addHole_(), _clearNodes_(), _updateEndIteratorSafe_(), addNode(), addNodeWithId(), asNodeSet(), bound(), existsNode(), nextNodeId(), operator=(), operator==(), populateNodes(), sizeNodes(), and toString().

_edges_

EdgeSet gum::EdgeGraphPart::_edges_

privateinherited

the set of all the edges contained within the EdgeGraphPart

Definition at line 238 of file edgeGraphPart.h.

Referenced by EdgeGraphPart(), EdgeGraphPart(), EdgeGraphPart(), _clearEdges_(), addEdge(), edges(), emptyEdges(), eraseEdge(), existsEdge(), operator=(), operator=(), operator==(), sizeEdges(), and toString().

_endIteratorSafe_

NodeGraphPartIteratorSafe gum::NodeGraphPart::_endIteratorSafe_

privateinherited

the end iterator (used to speed-up parsings of the NodeGraphPart)

Definition at line 537 of file nodeGraphPart.h.

Referenced by NodeGraphPart(), NodeGraphPart(), NodeGraphPart(), _updateEndIteratorSafe_(), end(), and endSafe().

_holes_

NodeSet* gum::NodeGraphPart::_holes_

privateinherited

the set of nodes not contained in the NodeGraphPart in the interval 1.

. max

Warning

holes may be nullptr.

Definition at line 523 of file nodeGraphPart.h.

Referenced by NodeGraphPart(), NodeGraphPart(), NodeGraphPart(), ~NodeGraphPart(), _addHole_(), _clearNodes_(), _eraseHole_(), _inHoles_(), _sizeHoles_(), addNode(), addNodeWithId(), nextNodeId(), operator=(), operator==(), populateNodes(), and sizeNodes().

_holes_resize_policy_

bool gum::NodeGraphPart::_holes_resize_policy_

privateinherited

value for holes configuration

Definition at line 534 of file nodeGraphPart.h.

Referenced by NodeGraphPart(), NodeGraphPart(), NodeGraphPart(), _addHole_(), addNodeWithId(), operator=(), and populateNodes().

_holes_size_

Size gum::NodeGraphPart::_holes_size_

privateinherited

value for holes configuration

Definition at line 531 of file nodeGraphPart.h.

Referenced by NodeGraphPart(), NodeGraphPart(), NodeGraphPart(), _addHole_(), addNodeWithId(), operator=(), and populateNodes().

_names_

std::unique_ptr< Bijection< NodeId, std::string > > gum::NodeGraphPart::_names_

privateinherited

optional node names — null when no name has been set

Definition at line 526 of file nodeGraphPart.h.

Referenced by NodeGraphPart(), NodeGraphPart(), _clearNodes_(), _cloneNames_(), dotNodeLabel(), eraseNode(), hasName(), idFromName(), nameFromId(), operator=(), populateNodes(), setName(), and toString().

_neighbours_

NodeProperty< NodeSet* > gum::EdgeGraphPart::_neighbours_

privateinherited

for each node, the set of its adjacent edges

Definition at line 241 of file edgeGraphPart.h.

Referenced by EdgeGraphPart(), EdgeGraphPart(), _checkNeighbours_(), _clearEdges_(), addEdge(), eraseEdge(), eraseNeighbours(), existsEdge(), neighbours(), operator=(), operator=(), and unvirtualizedEraseNeighbours().

onEdgeAdded

Signaler< NodeId, NodeId > gum::EdgeGraphPart::onEdgeAdded

inherited

Definition at line 98 of file edgeGraphPart.h.

Referenced by EdgeGraphPart(), addEdge(), operator=(), and operator=().

onEdgeDeleted

Signaler< NodeId, NodeId > gum::EdgeGraphPart::onEdgeDeleted

inherited

Definition at line 99 of file edgeGraphPart.h.

Referenced by _clearEdges_(), and eraseEdge().

onNodeAdded

Signaler< NodeId > gum::NodeGraphPart::onNodeAdded

inherited

Definition at line 281 of file nodeGraphPart.h.

Referenced by addNode(), and addNodeWithId().

onNodeDeleted

Signaler< NodeId > gum::NodeGraphPart::onNodeDeleted

inherited

Definition at line 282 of file nodeGraphPart.h.

Referenced by _clearNodes_(), and eraseNode().

---

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

• agrum/base/graphs/undiGraph.h
• agrum/base/graphs/undiGraph.cpp
• agrum/base/graphs/undiGraph_inl.h