gum::DiGraph Class Reference

Base class for all oriented graphs. More...

#include <diGraph.h>

Inheritance diagram for gum::DiGraph:

Collaboration diagram for gum::DiGraph:

Public Types
using	NodeIterator = NodeGraphPartIterator
using	NodeConstIterator = NodeGraphPartIterator
using	NodeIteratorSafe = NodeGraphPartIteratorSafe
using	NodeConstIteratorSafe = NodeGraphPartIteratorSafe
using	ArcIterator = ArcSetIterator
using	node_iterator = NodeGraphPartIterator
	types for STL compliance
using	node_const_iterator = NodeGraphPartIterator
	types for STL compliance
using	node_iterator_safe = NodeGraphPartIteratorSafe
	types for STL compliance
using	node_const_iterator_safe = NodeGraphPartIteratorSafe
	types for STL compliance

Public Member Functions
bool	hasDirectedPath (NodeId from, NodeId to) const
	checks whether there exists a directed path from from to to
std::optional< std::vector< NodeId > >	directedPath (NodeId node1, NodeId node2) const
	returns a directed path from node1 to node2, or std::nullopt if none
std::optional< std::vector< NodeId > >	directedUnorientedPath (NodeId node1, NodeId node2) const
	returns a shortest path from node1 to node2 ignoring arc orientation, or std::nullopt if none
NodeSet	ancestors (NodeId id) const
	returns the set of all ancestors of id (nodes from which id is reachable)
NodeSet	descendants (NodeId id) const
	returns the set of all descendants of id (nodes reachable from id)
NodeSet	family (NodeId id) const
	returns { id } ∪ parents(id)
NodeSet	family (const NodeSet &ids) const
	returns the union of families of all nodes in ids
NodeProperty< NodeId >	connectedComponents () const
	returns a property {node:id of weakly connected component}
Operators
DiGraph &	operator= (const DiGraph &g)
	copy operator
DiGraph &	operator= (DiGraph &&g)
	move assignment operator
bool	operator== (const DiGraph &g) const
	tests whether two DiGraphs are identical (same nodes, same arcs)
Accessors/Modifiers
tests whether two DiGraphs are different Parameters g the DiGraph with which "this" is compared
void	addArc (const NodeId tail, const NodeId head) override
	insert a new arc into the directed graph
void	eraseNode (const NodeId id) override
	remove a node and its adjacent arcs from the graph
void	clear () override
	removes all the nodes and arcs from the graph
std::string	toString () const override
	to friendly display the content of the graph
virtual std::string	toDot () const
	to friendly display the content of the graph in the DOT syntax
Sequence< NodeId >	topologicalOrder () const
	Build and return a topological order.
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 ArcGraphPart &p) const
	tests whether two ArcGraphParts contain the same arcs
Accessors/Modifiers
virtual void	eraseArc (const Arc &arc)
	removes an arc from the ArcGraphPart
bool	existsArc (const Arc &arc) const
	indicates whether a given arc exists
bool	existsArc (NodeId tail, NodeId head) const
	indicates whether a given arc exists
bool	emptyArcs () const
	indicates wether the ArcGraphPart contains any arc
void	clearArcs ()
	removes all the arcs from the ArcGraphPart
Size	sizeArcs () const
	indicates the number of arcs stored within the ArcGraphPart
const ArcSet &	arcs () const
	returns the set of arcs stored within the ArcGraphPart
const NodeSet &	parents (NodeId id) const
	returns the set of nodes with arc ingoing to a given node
NodeSet	parents (const NodeSet &ids) const
	returns the set of parents of a set of nodes
NodeSet	children (const NodeSet &ids) const
	returns the set of nodes which consists in the node and its parents returns the set of children of a set of nodes
const NodeSet &	children (NodeId id) const
	returns the set of nodes with arc outgoing from a given node
void	eraseParents (NodeId id)
	erase all the parents of a given node
void	unvirtualizedEraseParents (NodeId id)
	same function as eraseParents but without any virtual call to an erase
void	eraseChildren (NodeId id)
	removes all the children of a given node
void	unvirtualizedEraseChildren (NodeId id)
	same function as eraseChildren but without any virtual call to an erase
template<typename VAL>
ArcProperty< VAL >	arcsProperty (VAL(*f)(const Arc &), Size size=0) const
	a method to create a hashMap of VAL from a set of arcs (using for every arc, say x, the VAL f(x))
template<typename VAL>
ArcProperty< VAL >	arcsProperty (const VAL &a, Size size=0) const
	a method to create a hashMap of VAL from a set of arcs (using for every arc, say x, the VAL a)
template<typename VAL>
List< VAL >	listMapArcs (VAL(*f)(const Arc &)) const
	a method to create a list of VAL from a set of arcs (using for every arc, say x, the VAL f(x))

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

Protected Member Functions
void	eraseSetOfArcs_ (const ArcSet &set)
	a (virtualized) function to remove a given set of arcs
void	unvirtualizedEraseSetOfArcs_ (const ArcSet &set)
	similar to eraseSetOfArcs_ except that it is unvirtualized

Private Member Functions
void	_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	_checkParents_ (NodeId id)
	when the ArcGraphPart contains no arc ingoing into a given node, this function adds an empty set entry to parents[id]
void	_checkChildren_ (NodeId id)
	when the ArcGraphPart contains no arc outgoing from a given node, this function adds an empty set entry to children[id]
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
Set< Arc >	_arcs_
	the set of all the arcs contained within the ArcGraphPart
NodeProperty< NodeSet * >	_parents_
	for each arc, the sets of its parents
NodeProperty< NodeSet * >	_children_
	for each arc, the set of its children

Constructors / Destructors
	DiGraph (Size nodes_size=HashTableConst::default_size, bool nodes_resize_policy=true, Size arcs_size=HashTableConst::default_size, bool arcs_resize_policy=true)
	default constructor
	DiGraph (const DiGraph &g)
	copy constructor
	DiGraph (DiGraph &&g)
	move constructor
	~DiGraph () override
	destructor
static DiGraph	completeGraph (int n)
	Build a complete DiGraph with n nodes.

Detailed Description

Base class for all oriented graphs.

This is the base class for graphs containing directed edges (so-called arcs)

• Usage example:

  // creating empty graphs
  DiGraph g1,g2;
   
  // adding nodes and arcs to g1
  NodeId i1=g1.addNode();
  NodeId i2=g1.addNode();
  NodeId i3=g1.addNode();
  g1.addArc( i1,i2 );
  g1.addArc( i1,i3 );
  g1.addArc( i2,i3 );
   
  //throw an InvalidNode
  // g1.addArc( i1+i2+i3,i1 );
   
  // copying graphs
  DiGraph g3 = g1;
  g2 = g1;
  DiGraph g4=g1;
   
  // check if a graph has no node
  if ( g1.empty() ) cerr << "graph g1 is empty" << endl;
   
  // remove all the nodes (as well as their adjacent arcs)
  g1.clear();
   
  // remove some arc
  g4.eraseArc( Arc ( i1,i3 ) );
   
  // remove node
  g2.eraseNode( i2 );
   
  // parse a graph
  for ( const auto node : g3.nodes() )
    cerr << node<< endl;
   
  for ( const auto & arc : g3.arcs())
    cerr << arc << endl;
   
  const ArcSet& a=g3.parents( 3 );
   
  for ( const auto & par : g3.parents(3))
    cerr << "  -  "<< par;
   
  cerr<<endl;
   
  // remove all the arcs that are parent of a given node
  g3.eraseParents( 2 );

Definition at line 132 of file diGraph.h.

Member Typedef Documentation

ArcIterator

using gum::ArcGraphPart::ArcIterator = ArcSetIterator

inherited

Definition at line 100 of file arcGraphPart.h.

node_const_iterator

using gum::NodeGraphPart::node_const_iterator = NodeGraphPartIterator

inherited

types for STL compliance

Definition at line 268 of file nodeGraphPart.h.

node_const_iterator_safe

using gum::NodeGraphPart::node_const_iterator_safe = NodeGraphPartIteratorSafe

inherited

types for STL compliance

Definition at line 270 of file nodeGraphPart.h.

node_iterator

using gum::NodeGraphPart::node_iterator = NodeGraphPartIterator

inherited

types for STL compliance

Definition at line 267 of file nodeGraphPart.h.

node_iterator_safe

using gum::NodeGraphPart::node_iterator_safe = NodeGraphPartIteratorSafe

inherited

types for STL compliance

Definition at line 269 of file nodeGraphPart.h.

NodeConstIterator

using gum::NodeGraphPart::NodeConstIterator = NodeGraphPartIterator

inherited

Definition at line 277 of file nodeGraphPart.h.

NodeConstIteratorSafe

using gum::NodeGraphPart::NodeConstIteratorSafe = NodeGraphPartIteratorSafe

inherited

Definition at line 279 of file nodeGraphPart.h.

NodeIterator

using gum::NodeGraphPart::NodeIterator = NodeGraphPartIterator

inherited

Definition at line 276 of file nodeGraphPart.h.

NodeIteratorSafe

using gum::NodeGraphPart::NodeIteratorSafe = NodeGraphPartIteratorSafe

inherited

Definition at line 278 of file nodeGraphPart.h.

Constructor & Destructor Documentation

DiGraph() [1/3]

gum::DiGraph::DiGraph ( Size nodes_size = HashTableConst::default_size, bool nodes_resize_policy = true, Size arcs_size = HashTableConst::default_size, bool arcs_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
arcs_size	the size of the hash table used to store all the arcs
arcs_resize_policy	the resizing policy of this hash table

Definition at line 70 of file diGraph.cpp.

                                            :
      NodeGraphPart(nodes_size, nodes_resize_policy), ArcGraphPart(arcs_size, arcs_resize_policy) {
    GUM_CONSTRUCTOR(DiGraph)
  }

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

Referenced by gum::DAG::DAG(), gum::DAG::DAG(), gum::DAG::DAG(), DiGraph(), DiGraph(), DiGraph(), gum::MixedGraph::MixedGraph(), gum::MixedGraph::MixedGraph(), gum::MixedGraph::MixedGraph(), gum::MixedGraph::MixedGraph(), gum::MixedGraph::MixedGraph(), gum::prm::gspan::Pattern::Pattern(), gum::prm::gspan::Pattern::Pattern(), ~DiGraph(), completeGraph(), operator=(), operator=(), and operator==().

Here is the call graph for this function:

Here is the caller graph for this function:

DiGraph() [2/3]

gum::DiGraph::DiGraph

(

const DiGraph &

g

)

copy constructor

Parameters

g	the DiGraph to copy

Definition at line 78 of file diGraph.cpp.

: NodeGraphPart(g), ArcGraphPart(g) { GUM_CONS_CPY(DiGraph) }

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

Here is the call graph for this function:

DiGraph() [3/3]

gum::DiGraph::DiGraph

(

DiGraph &&

g

)

move constructor

Definition at line 80 of file diGraph.cpp.

                              : NodeGraphPart(std::move(g)), ArcGraphPart(std::move(g)) {
    GUM_CONS_MOV(DiGraph)
  }

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

Here is the call graph for this function:

~DiGraph()

gum::DiGraph::~DiGraph ( )

override

destructor

Definition at line 84 of file diGraph.cpp.

{ GUM_DESTRUCTOR(DiGraph) }

References DiGraph().

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:

_checkChildren_()

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

privateinherited

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

Parameters

id	the node whose children[id] is checked

Definition at line 72 of file arcGraphPart_inl.h.

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

References _children_.

Referenced by addArc().

Here is the caller graph for this function:

_checkParents_()

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

privateinherited

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

Parameters

id	the node whose parents[id] is checked

Definition at line 68 of file arcGraphPart_inl.h.

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

References _parents_.

Referenced by addArc().

Here is the caller graph for this function:

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

addArc()

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

overridevirtual

insert a new arc into the directed graph

Parameters

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

Warning

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

Exceptions

InvalidNode

if head or tail does not belong to the graph nodes

Reimplemented from gum::ArcGraphPart.

Reimplemented in gum::PDAG, and gum::prm::gspan::Pattern.

Definition at line 59 of file diGraph_inl.h.

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

References gum::ArcGraphPart::addArc(), gum::NodeGraphPart::exists(), and GUM_ERROR.

Referenced by gum::EssentialGraph::_buildEssentialGraph_(), gum::MeekRules::_propagatesOrientationInChainOfRemainingEdges_(), gum::DAG::addArc(), gum::PDAG::addArc(), gum::prm::gspan::Pattern::addArc(), completeGraph(), gum::learning::SimpleMiic::learnPDAG(), gum::learning::SimpleMiic::learnStructure(), gum::graph::moralizedAncestralGraph(), gum::learning::IBNLearner::prepareFCI_(), gum::learning::IBNLearner::prepareMiic_(), gum::learning::IBNLearner::preparePC_(), gum::learning::SimpleMiic::propagatesOrientationInChainOfRemainingEdges_(), gum::learning::StructuralConstraintDAG::setGraphAlone(), 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::UndiGraph::partialUndiGraph(), populateNodesFromProperty(), gum::learning::IBNLearner::prepareFCI_(), gum::learning::IBNLearner::prepareMiic_(), gum::learning::IBNLearner::preparePC_(), gum::MeekRules::propagateToCPDAG(), gum::MeekRules::propagateToDAG(), gum::learning::StructuralConstraintDAG::setGraphAlone(), gum::EssentialGraph::skeleton(), and gum::PAG::toMixedGraph().

Here is the call graph for this function:

Here is the caller graph for this function:

ancestors()

INLINE NodeSet gum::DiGraph::ancestors

(

NodeId

id

)

const

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

Definition at line 119 of file diGraph_inl.h.

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

References gum::graph::ancestors().

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

Here is the call graph for this function:

Here is the caller graph for this function:

arcs()

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

inherited

returns the set of arcs stored within the ArcGraphPart

Definition at line 60 of file arcGraphPart_inl.h.

{ return _arcs_; }

References _arcs_.

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

Here is the caller graph for this function:

arcsProperty() [1/2]

template<typename VAL>

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

inherited

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

Parameters

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

arcsProperty() [2/2]

template<typename VAL>

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

inherited

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

Parameters

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

asNodeSet()

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

inherited

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

Warning

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

for(const auto n : nodes()) 

rather than

for(const auto n : asNodeSet()) 

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:

children() [1/2]

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

inherited

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

returns the set of children of a set of nodes

Definition at line 82 of file arcGraphPart_inl.h.

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

References children().

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

Here is the call graph for this function:

children() [2/2]

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

inherited

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

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

Parameters

id	the node which is the tail of the arcs returned

Definition at line 97 of file arcGraphPart_inl.h.

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

References _children_, and gum::emptyNodeSet.

clear()

INLINE void gum::DiGraph::clear ( )

overridevirtual

removes all the nodes and arcs from the graph

Reimplemented from gum::NodeGraphPart.

Reimplemented in gum::MixedGraph.

Definition at line 67 of file diGraph_inl.h.

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

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

Referenced by operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

clearArcs()

void gum::ArcGraphPart::clearArcs ( )

inherited

removes all the arcs from the ArcGraphPart

Definition at line 104 of file arcGraphPart.cpp.

                               {
    for (const auto& elt: _parents_)
      delete elt.second;
 
    _parents_.clear();
 
    for (const auto& elt: _children_)
      delete elt.second;
 
    _children_.clear();
 
    // we need this copy only if at least one onArcDeleted listener exists
    if (onArcDeleted.hasListener()) {
      ArcSet tmp = _arcs_;
      _arcs_.clear();
 
      for (const auto& arc: tmp)
        GUM_EMIT2(onArcDeleted, arc.tail(), arc.head());
    } else {
      _arcs_.clear();
    }
  }

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

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

Here is the caller graph for this function:

clearNodes()

INLINE void gum::NodeGraphPart::clearNodes ( )

virtualinherited

remove all the nodes from the NodeGraphPart

Definition at line 325 of file nodeGraphPart_inl.h.

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

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

static

Build a complete DiGraph with n nodes.

Parameters

int

n

Returns

the complete DiGraph

Definition at line 58 of file diGraph.cpp.

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

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

Here is the call graph for this function:

connectedComponents()

INLINE NodeProperty< NodeId > gum::DiGraph::connectedComponents

(

)

const

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

Definition at line 127 of file diGraph_inl.h.

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

References gum::graph::connectedComponents().

Here is the call graph for this function:

descendants()

INLINE NodeSet gum::DiGraph::descendants

(

NodeId

id

)

const

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

Definition at line 121 of file diGraph_inl.h.

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

References gum::graph::descendants().

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

Here is the call graph for this function:

Here is the caller graph for this function:

directedPath()

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

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

Definition at line 109 of file diGraph_inl.h.

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

References gum::graph::directedPath().

Here is the call graph for this function:

directedUnorientedPath()

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

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

Definition at line 115 of file diGraph_inl.h.

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

References gum::graph::directedUnorientedPath().

Here is the call graph for this function:

dotNodeLabel()

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

inherited

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

Definition at line 188 of file nodeGraphPart.cpp.

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

References _names_, and hasName().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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:

emptyArcs()

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

inherited

indicates wether the ArcGraphPart contains any arc

Definition at line 56 of file arcGraphPart_inl.h.

{ return _arcs_.empty(); }

References _arcs_.

emptyNodes()

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

inherited

indicates whether there exists nodes in the NodeGraphPart

Definition at line 319 of file nodeGraphPart_inl.h.

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

References sizeNodes().

Referenced by empty(), and populateNodesFromProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

end()

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

noexceptinherited

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

Definition at line 352 of file nodeGraphPart_inl.h.

                                                                        {
    return _endIteratorSafe_;
  }

References _endIteratorSafe_, and NodeGraphPartIterator.

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

Here is the call graph for this function:

Here is the caller graph for this function:

endSafe()

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

noexceptinherited

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

Definition at line 342 of file nodeGraphPart_inl.h.

                                                                                {
    return _endIteratorSafe_;
  }

References _endIteratorSafe_, and NodeGraphPartIteratorSafe.

Referenced by populateNodesFromProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

eraseArc()

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

virtualinherited

removes an arc from the ArcGraphPart

Parameters

arc	the arc to be removed

Warning

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

Definition at line 114 of file arcGraphPart_inl.h.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

eraseChildren()

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

inherited

removes all the children of a given node

Parameters

id	the node all the children of which will be removed

Warning

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

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

Definition at line 146 of file arcGraphPart_inl.h.

                                                   {
    if (_children_.exists(id)) {
      const NodeSet& children = *(_children_[id]);
 
      for (auto iter = children.beginSafe();   // safe iterator needed here
           iter != children.endSafe();
           ++iter) {
        // warning: use this erase so that you actually use the virtualized
        // arc removal function
        eraseArc(Arc(id, *iter));
      }
    }
  }

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

Here is the call graph for this function:

eraseNode()

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

overridevirtual

remove a node and its adjacent arcs from the graph

Parameters

id	the id of the node to be removed

Warning

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

Reimplemented from gum::NodeGraphPart.

Reimplemented in gum::MixedGraph.

Definition at line 93 of file diGraph_inl.h.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

eraseParents()

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

inherited

erase all the parents of a given node

Parameters

id	the node all the parents of which will be removed

Warning

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

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

Definition at line 132 of file arcGraphPart_inl.h.

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

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

Here is the call graph for this function:

eraseSetOfArcs_()

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

protectedinherited

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

Warning

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

Definition at line 127 of file arcGraphPart_inl.h.

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

References eraseArc().

Here is the call graph for this function:

exists()

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:

existsArc() [1/2]

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

inherited

indicates whether a given arc exists

Parameters

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

Definition at line 62 of file arcGraphPart_inl.h.

{ return _arcs_.contains(arc); }

References _arcs_.

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

Here is the caller graph for this function:

existsArc() [2/2]

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

inherited

indicates whether a given arc exists

Parameters

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

Definition at line 64 of file arcGraphPart_inl.h.

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

References _parents_.

existsNode()

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

inherited

returns true iff the NodeGraphPart contains the given nodeId

Definition at line 301 of file nodeGraphPart_inl.h.

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

References _boundVal_, and _inHoles_().

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

Here is the call graph for this function:

Here is the caller graph for this function:

family() [1/2]

INLINE NodeSet gum::DiGraph::family

(

const NodeSet &

ids

)

const

returns the union of families of all nodes in ids

Definition at line 125 of file diGraph_inl.h.

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

References gum::graph::family().

Here is the call graph for this function:

family() [2/2]

INLINE NodeSet gum::DiGraph::family

(

NodeId

id

)

const

returns { id } ∪ parents(id)

Definition at line 123 of file diGraph_inl.h.

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

References gum::graph::family().

Here is the call graph for this function:

hasDirectedPath()

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

checks whether there exists a directed path from from to to

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

Parameters

from
to

Returns

true if a directed path exists

Definition at line 114 of file diGraph.cpp.

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

References gum::graph::hasDirectedPath().

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

Here is the call graph for this function:

Here is the caller graph for this function:

hasName()

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

inherited

returns true iff node id has an explicit name

Definition at line 186 of file nodeGraphPart.cpp.

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

References _names_.

Referenced by dotNodeLabel(), and populateNodesFromProperty().

Here is the caller graph for this function:

idFromName()

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

inherited

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

Definition at line 165 of file nodeGraphPart.cpp.

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

References _names_.

Referenced by populateNodesFromProperty().

Here is the caller graph for this function:

listMapArcs()

template<typename VAL>

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

inherited

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

Parameters

f	a function assigning a VAL to any arc

listMapNodes()

template<typename VAL>

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

inherited

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

Parameters

f	a function assigning a VAL to any node

References listMapNodes().

Referenced by listMapNodes().

Here is the call graph for this function:

Here is the caller graph for this function:

nameFromId()

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

inherited

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

Definition at line 160 of file nodeGraphPart.cpp.

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

References _names_.

Referenced by populateNodesFromProperty().

Here is the caller graph for this function:

nextNodeId()

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

inherited

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

Warning

a code like

id=nextNodeId();addNode(id); 

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

(

const DiGraph &

g

)

copy operator

Parameters

g	the DiGraph to copy

Definition at line 72 of file diGraph_inl.h.

                                                   {
    // avoid self assigment
    if (this != &g) {
      DiGraph::clear();
      NodeGraphPart::operator=(g);
      ArcGraphPart::operator=(g);
      GUM_OP_CPY(DiGraph);
    }
 
    return *this;
  }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [2/2]

INLINE DiGraph & gum::DiGraph::operator=

(

DiGraph &&

g

)

move assignment operator

Definition at line 84 of file diGraph_inl.h.

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

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

Here is the call graph for this function:

operator==() [1/3]

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

inherited

tests whether two ArcGraphParts contain the same arcs

Parameters

p	the ArcGraphPart that we compare with this

Definition at line 189 of file arcGraphPart_inl.h.

{ return _arcs_ == p._arcs_; }

References ArcGraphPart(), and _arcs_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

operator==() [2/3]

INLINE bool gum::DiGraph::operator==

(

const DiGraph &

g

)

const

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

Parameters

g	the DiGraph with which "this" is compared

Definition at line 103 of file diGraph_inl.h.

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

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

Here is the call graph for this function:

operator==() [3/3]

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

inherited

check whether two NodeGraphParts contain the same nodes

Parameters

p	the NodeGraphPart to be compared with "this"

Definition at line 356 of file nodeGraphPart_inl.h.

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

References NodeGraphPart(), _boundVal_, and _holes_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

parents() [1/2]

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

inherited

returns the set of parents of a set of nodes

Definition at line 90 of file arcGraphPart_inl.h.

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

References parents().

Here is the call graph for this function:

parents() [2/2]

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

inherited

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

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

Parameters

id	the node toward which the arcs returned are pointing

Definition at line 76 of file arcGraphPart_inl.h.

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

References _parents_, and gum::emptyNodeSet.

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

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:

sizeArcs()

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

inherited

indicates the number of arcs stored within the ArcGraphPart

Definition at line 58 of file arcGraphPart_inl.h.

{ return _arcs_.size(); }

References _arcs_.

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

Here is the caller graph for this function:

sizeNodes()

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

inherited

returns the number of nodes in the NodeGraphPart

Definition at line 295 of file nodeGraphPart_inl.h.

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

References _boundVal_, and _holes_.

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

Here is the caller graph for this function:

toDot()

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

virtual

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

Parameters

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

Returns

Returns a string describing the graph in the dot syntax

Reimplemented in gum::MixedGraph, gum::PDAG, and gum::prm::gspan::Pattern.

Definition at line 93 of file diGraph.cpp.

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

References gum::ArcGraphPart::arcs(), gum::NodeGraphPart::dotNodeLabel(), and gum::NodeGraphPart::nodes().

Here is the call graph for this function:

topologicalOrder()

INLINE Sequence< NodeId > gum::DiGraph::topologicalOrder

(

)

const

Build and return a topological order.

Exceptions

InvalidDirectedCycle

Raised if this DiGraph contains cycles.

Definition at line 131 of file diGraph_inl.h.

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

References gum::graph::topologicalOrder().

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

Here is the call graph for this function:

Here is the caller graph for this function:

toString()

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

overridevirtual

to friendly display the content of the graph

Reimplemented from gum::NodeGraphPart.

Reimplemented in gum::MixedGraph.

Definition at line 86 of file diGraph.cpp.

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

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

Referenced by gum::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

unvirtualizedEraseChildren()

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

inherited

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

Parameters

id	the node whose outgoing arcs will be removed

Definition at line 177 of file arcGraphPart_inl.h.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

unvirtualizedEraseParents()

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

inherited

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

Parameters

id	the node whose ingoing arcs will be removed

Definition at line 165 of file arcGraphPart_inl.h.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

unvirtualizedEraseSetOfArcs_()

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

protectedinherited

similar to eraseSetOfArcs_ except that it is unvirtualized

Warning

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

Definition at line 160 of file arcGraphPart_inl.h.

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

References eraseArc().

Here is the call graph for this function:

Member Data Documentation

_arcs_

Set< Arc > gum::ArcGraphPart::_arcs_

privateinherited

the set of all the arcs contained within the ArcGraphPart

Definition at line 281 of file arcGraphPart.h.

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

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

_children_

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

privateinherited

for each arc, the set of its children

Definition at line 287 of file arcGraphPart.h.

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

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

_parents_

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

privateinherited

for each arc, the sets of its parents

Definition at line 284 of file arcGraphPart.h.

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

onArcAdded

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

inherited

Definition at line 102 of file arcGraphPart.h.

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

onArcDeleted

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

inherited

Definition at line 103 of file arcGraphPart.h.

Referenced by clearArcs(), and eraseArc().

onNodeAdded

Signaler< NodeId > gum::NodeGraphPart::onNodeAdded

inherited

Definition at line 281 of file nodeGraphPart.h.

Referenced by addNode(), and addNodeWithId().

onNodeDeleted

Signaler< NodeId > gum::NodeGraphPart::onNodeDeleted

inherited

Definition at line 282 of file nodeGraphPart.h.

Referenced by _clearNodes_(), and eraseNode().

---

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

• agrum/base/graphs/diGraph.h
• agrum/base/graphs/diGraph.cpp
• agrum/base/graphs/diGraph_inl.h