Basic graph of cliques. More...

#include <cliqueGraph.h>

Inheritance diagram for gum::CliqueGraph:

Collaboration diagram for gum::CliqueGraph:

Classes
struct	_RunningIntersect_
	structure used for the computation of the running intersection property More...

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

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

Public Member Functions
Constructors / Destructors
	CliqueGraph (Size nodes_size=HashTableConst::default_size, bool nodes_resize_policy=true, Size edges_size=HashTableConst::default_size, bool edges_resize_policy=true)
	basic constructor: creates an empty clique graph
	CliqueGraph (const CliqueGraph &from)
	copy constructor
	CliqueGraph (CliqueGraph &&from)
	move constructor
	~CliqueGraph () override
	destructor
Accessors/Modifiers
void	addEdge (NodeId first, NodeId second) override
	inserts a new edge between two cliques
void	eraseEdge (const Edge &edge) override
	removes an edge (and its separator) from the clique graph
void	clearEdges () override
	removes all edges and their separators
NodeId	addNode (const NodeSet &clique)
	adds a new clique to the graph
NodeId	addNode () override
	adds a new clique to the graph
void	addNodeWithId (const NodeId id, const NodeSet &clique)
	try to add a new clique to the graph
void	addNodeWithId (const NodeId id) override
	try to add a new clique to the graph
void	eraseNode (const NodeId node) override
	removes a given clique from the clique graph
void	clear () override
	removes all the cliques and separators from the graph (as well as their adjacent edges)
const NodeSet &	clique (const NodeId idClique) const
	returns the set of nodes included into a given clique
NodeId	container (const NodeId idNode) const
	returns the id of a clique containing the node the id of which is in argument
virtual void	setClique (const NodeId idClique, const NodeSet &new_clique)
	changes the set of nodes included into a given clique and returns the new set
virtual void	addToClique (const NodeId clique_id, const NodeId node_id)
	changes the set of nodes included into a given clique and returns the new set
virtual void	eraseFromClique (const NodeId clique_id, const NodeId node_id)
	remove a node from a clique
const NodeSet &	separator (const Edge &edge) const
	returns the separator included in a given edge
const NodeSet &	separator (const NodeId clique1, const NodeId clique) const
	returns the separator included in an edge specified by its extremities
std::vector< NodeId >	containerPath (const NodeId node1, const NodeId node2) const
	returns a path from a clique containing node1 to a clique containing node2
bool	hasRunningIntersection () const
	indicates whether the running intersection property holds
bool	isJoinTree () const
	indicates whether the graph is a join tree
std::string	toString () const override
	friendly displays the content of the CliqueGraph
std::string	toDot () const override
	friendly displays the content of the CliqueGraph in DOT format
virtual std::string	mapToDot (double scaleClique, double scaleSep, double lenEdge, std::string_view colorClique="burlywood", std::string_view colorSep="palegreen") const
	friendly displays the content of the map of the CliqueGraph in DOT format
Operators
CliqueGraph &	operator= (const CliqueGraph &from)
	copy operator
CliqueGraph &	operator= (CliqueGraph &&from)
	move operator
bool	operator== (const CliqueGraph &from) const
	checks whether two clique graphs are equal
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
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
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
Accessors/Modifiers
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
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))
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
std::vector< NodeId >	addNodes (Size n)
	insert n nodes
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))

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

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

Private Member Functions
void	_updateSeparators_ (const NodeId clique1)
	function used to update the separators when a clique is modified
bool	_runningIntersectionDFS_ (const NodeId clique, const NodeId from, _RunningIntersect_ &infos_DFS) const
	function used for the computation of the running intersection property
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_ ()

Private Attributes
NodeProperty< NodeSet >	_cliques_
	the set of nodes contained into the cliques
EdgeProperty< NodeSet >	_separators_
	the set of nodes contained into the separators
EdgeSet	_edges_
	the set of all the edges contained within the EdgeGraphPart
NodeProperty< NodeSet * >	_neighbours_
	for each node, the set of its adjacent edges

Detailed Description

Basic graph of cliques.

A CliqueGraph is an undirected graph the nodes of which are Cliques, i.e., sets of NodeIds. Cliques are linked by Edges. These edges contain separators that are actually the intersection of the two Cliques at the extremities of the edge.

Definition at line 77 of file cliqueGraph.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

◆ CliqueGraph() [1/3]

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

explicit

basic constructor: creates an empty clique graph

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

References gum::HashTableConst::default_size.

Referenced by CliqueGraph(), CliqueGraph(), operator=(), operator=(), and operator==().

Here is the caller graph for this function:

◆ CliqueGraph() [2/3]

gum::CliqueGraph::CliqueGraph ( const CliqueGraph & from )

copy constructor

Parameters

from	the CliqueGraph that will be copied into this

References CliqueGraph().

Here is the call graph for this function:

◆ CliqueGraph() [3/3]

gum::CliqueGraph::CliqueGraph ( CliqueGraph && from )

move constructor

References CliqueGraph().

Here is the call graph for this function:

◆ ~CliqueGraph()

gum::CliqueGraph::~CliqueGraph ( )

override

destructor

Member Function Documentation

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

◆ _runningIntersectionDFS_()

bool gum::CliqueGraph::_runningIntersectionDFS_	(	const NodeId	clique,
		const NodeId	from,
		_RunningIntersect_ &	infos_DFS ) const

private

function used for the computation of the running intersection property

References clique().

Here is the call graph for this function:

◆ _updateSeparators_()

void gum::CliqueGraph::_updateSeparators_ ( const NodeId clique1 )

private

function used to update the separators when a clique is modified

◆ addEdge()

void gum::CliqueGraph::addEdge	(	NodeId	first,
		NodeId	second )

overridevirtual

inserts a new edge between two cliques

Parameters

first	the id of one extremity of the new edge to be inserted
second	the id of the other extremity of the new edge to be inserted

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.

Referenced by gum::BinaryJoinTreeConverterDefault::_convertClique_().

Here is the caller graph for this function:

◆ addNode() [1/2]

NodeId gum::CliqueGraph::addNode ( )

overridevirtual

adds a new clique to the graph

Returns: the id chosen for the new clique

Reimplemented from gum::NodeGraphPart.

◆ addNode() [2/2]

NodeId gum::CliqueGraph::addNode ( const NodeSet & clique )

adds a new clique to the graph

Returns: the id chosen for the new clique

References clique().

Referenced by gum::BinaryJoinTreeConverterDefault::_convertClique_().

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

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

overridevirtual

try to add a new clique to the graph

Exceptions

DuplicateElement exception is thrown if the id of the clique already exists within the clique graph

Reimplemented from gum::NodeGraphPart.

◆ addNodeWithId() [2/2]

void gum::CliqueGraph::addNodeWithId	(	const NodeId	id,
		const NodeSet &	clique )

try to add a new clique to the graph

Exceptions

DuplicateElement exception is thrown if the id of the clique already exists within the clique graph

References clique().

Here is the call graph for this function:

◆ addToClique()

virtual void gum::CliqueGraph::addToClique	(	const NodeId	clique_id,
		const NodeId	node_id )

virtual

changes the set of nodes included into a given clique and returns the new set

Exceptions

NotFound	exception is thrown if clique_id does not exist
DuplicateElement	exception is thrown if clique_id set already contains the node

◆ asNodeSet()

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

inherited

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

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

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

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:

◆ chainComponents()

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

inherited

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

void gum::CliqueGraph::clear ( )

overridevirtual

removes all the cliques and separators from the graph (as well as their adjacent edges)

Reimplemented from gum::NodeGraphPart.

◆ clearEdges()

void gum::CliqueGraph::clearEdges ( )

overridevirtual

removes all edges and their separators

Reimplemented from gum::EdgeGraphPart.

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

◆ clique()

const NodeSet & gum::CliqueGraph::clique ( const NodeId idClique ) const

returns the set of nodes included into a given clique

Exceptions

NotFound exception is raised if the clique does not belong to the clique graph

Referenced by _runningIntersectionDFS_(), addNode(), addNodeWithId(), gum::BarrenNodesFinder::barrenNodes(), gum::Triangulation::maxLog10CliqueDomainSize(), and separator().

Here is the caller graph for this function:

◆ completeGraph()

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

inherited

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:

◆ container()

NodeId gum::CliqueGraph::container ( const NodeId idNode ) const

returns the id of a clique containing the node the id of which is in argument

Warning: note that this method is time consuming as the clique graph does not contain priori information about which clique could contain idNode. As a consequence, it searches the cliques until it finds one that actually contains idNode.

Exceptions

NotFound exception is thrown if no clique contains idNode

◆ containerPath()

std::vector< NodeId > gum::CliqueGraph::containerPath	(	const NodeId	node1,
		const NodeId	node2 ) const

returns a path from a clique containing node1 to a clique containing node2

Exceptions

NotFound such path cannot be found

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

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

◆ eraseEdge()

void gum::CliqueGraph::eraseEdge ( const Edge & edge )

overridevirtual

removes an edge (and its separator) from the clique graph

Parameters

edge	the edge to be removed

Warning: if the edge does not exist, nothing is done. In particular, no exception is thrown.

Reimplemented from gum::EdgeGraphPart.

Referenced by gum::BinaryJoinTreeConverterDefault::_convertClique_().

Here is the caller graph for this function:

◆ eraseFromClique()

virtual void gum::CliqueGraph::eraseFromClique	(	const NodeId	clique_id,
		const NodeId	node_id )

virtual

remove a node from a clique

If node_id cannot be found in the clique set, then the function does nothing. In particular, it does not throw any exception.

Exceptions

NotFound exception is thrown if clique_id does not exist

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

void gum::CliqueGraph::eraseNode ( const NodeId node )

overridevirtual

removes a given clique from the clique graph

If the CliqueGraph does not contain the node, then nothing is done. In particular, no exception is raised.

Reimplemented from gum::NodeGraphPart.

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

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

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

◆ hasRunningIntersection()

bool gum::CliqueGraph::hasRunningIntersection ( ) const

indicates whether the running intersection property holds

The function works properly even if the graph contains cycles.

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

◆ isJoinTree()

bool gum::CliqueGraph::isJoinTree ( ) const

indicates whether the graph is a join tree

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

◆ mapToDot()

virtual std::string gum::CliqueGraph::mapToDot	(	double	scaleClique,
		double	scaleSep,
		double	lenEdge,
		std::string_view	colorClique = "burlywood",
		std::string_view	colorSep = "palegreen" ) const

virtual

friendly displays the content of the map of the CliqueGraph in DOT format

◆ 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::CliqueGraph::addNode
NodeId addNode() override
adds a new clique to the graph

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]

CliqueGraph & gum::CliqueGraph::operator= ( CliqueGraph && from )

move operator

References CliqueGraph().

Here is the call graph for this function:

◆ operator=() [2/2]

CliqueGraph & gum::CliqueGraph::operator= ( const CliqueGraph & from )

copy operator

References CliqueGraph().

Here is the call graph for this function:

◆ operator==() [1/4]

bool gum::CliqueGraph::operator== ( const CliqueGraph & from ) const

checks whether two clique graphs are equal

References CliqueGraph().

Here is the call graph for this function:

◆ operator==() [2/4]

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

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

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:

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

◆ separator() [1/2]

const NodeSet & gum::CliqueGraph::separator ( const Edge & edge ) const

returns the separator included in a given edge

Exceptions

NotFound exception is thrown if the edge does not belong to the clique graph

Referenced by gum::BinaryJoinTreeConverterDefault::_convertClique_(), and gum::BarrenNodesFinder::barrenNodes().

Here is the caller graph for this function:

◆ separator() [2/2]

const NodeSet & gum::CliqueGraph::separator	(	const NodeId	clique1,
		const NodeId	clique ) const

returns the separator included in an edge specified by its extremities

Exceptions

NotFound exception is thrown if the edge does not belong to the clique graph

References clique().

Here is the call graph for this function:

◆ setClique()

virtual void gum::CliqueGraph::setClique	(	const NodeId	idClique,
		const NodeSet &	new_clique )

virtual

changes the set of nodes included into a given clique and returns the new set

Exceptions

NotFound exception is thrown if idClique is not a clique of the clique graph

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

◆ 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::CliqueGraph::toDot ( ) const

overridevirtual

friendly displays the content of the CliqueGraph in DOT format

Reimplemented from gum::UndiGraph.

◆ toString()

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

overridevirtual

friendly displays the content of the CliqueGraph

Reimplemented from gum::NodeGraphPart.

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

◆ 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

◆ _cliques_

NodeProperty< NodeSet > gum::CliqueGraph::_cliques_

private

the set of nodes contained into the cliques

Definition at line 273 of file cliqueGraph.h.

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

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

◆ _separators_

EdgeProperty< NodeSet > gum::CliqueGraph::_separators_

private

the set of nodes contained into the separators

Definition at line 276 of file cliqueGraph.h.

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

agrum/base/graphs/cliqueGraph.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EdgeIterator

◆ node_const_iterator

◆ node_const_iterator_safe

◆ node_iterator

◆ node_iterator_safe

◆ NodeConstIterator

◆ NodeConstIteratorSafe

◆ NodeIterator

◆ NodeIteratorSafe

Constructor & Destructor Documentation

◆ CliqueGraph() [1/3]

◆ CliqueGraph() [2/3]

◆ CliqueGraph() [3/3]

◆ ~CliqueGraph()

Member Function Documentation

◆ _checkNeighbours_()

◆ _clearEdges_()

◆ _runningIntersectionDFS_()

◆ _updateSeparators_()

◆ addEdge()

◆ addNode() [1/2]

◆ addNode() [2/2]

◆ addNodes()

◆ addNodeWithId() [1/2]

◆ addNodeWithId() [2/2]

◆ addToClique()

◆ asNodeSet()

◆ begin()

◆ beginSafe()

◆ bound()

◆ chainComponents()

◆ clear()

◆ clearEdges()

◆ clearNodes()

◆ clique()

◆ completeGraph()

◆ connectedComponents()

◆ container()

◆ containerPath()

◆ dotNodeLabel()

◆ edges()

◆ edgesProperty() [1/2]

◆ edgesProperty() [2/2]

◆ empty()

◆ emptyEdges()

◆ emptyNodes()

◆ end()

◆ endSafe()

◆ eraseEdge()

◆ eraseFromClique()

◆ eraseNeighbours()

◆ eraseNode()

◆ exists()

◆ existsEdge() [1/2]

◆ existsEdge() [2/2]

◆ existsNode()

◆ hasName()

◆ hasRunningIntersection()

◆ hasUndirectedCycle()

◆ hasUndirectedPath() [1/3]

◆ hasUndirectedPath() [2/3]

◆ hasUndirectedPath() [3/3]

◆ idFromName()

◆ isJoinTree()

◆ listMapEdges()

◆ listMapNodes()

◆ mapToDot()

◆ nameFromId()

◆ neighbours()

◆ nextNodeId()

◆ nodes()