gum::NodeGraphPart Class Reference

Class for node sets in graph. More...

#include <nodeGraphPart.h>

Inheritance diagram for gum::NodeGraphPart:

Collaboration diagram for gum::NodeGraphPart:

Public Types
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
	NodeGraphPart (Size holes_size=HashTableConst::default_size, bool holes_resize_policy=true)
	default constructor
	NodeGraphPart (const NodeGraphPart &s)
	copy constructor
	NodeGraphPart (NodeGraphPart &&s)
	move constructor
virtual	~NodeGraphPart ()
	destructor
Operators
NodeGraphPart &	operator= (const NodeGraphPart &p)
	copy operator
NodeGraphPart &	operator= (NodeGraphPart &&p)
	move assignment operator
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
virtual void	eraseNode (const NodeId id)
	erase the 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
virtual void	clear ()
	alias for clearNodes
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
virtual std::string	toString () const
	a function to display the set of nodes
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))

Public Attributes
Signaler< NodeId >	onNodeAdded
Signaler< NodeId >	onNodeDeleted

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

Friends
class	NodeGraphPartIterator
class	NodeGraphPartIteratorSafe

Detailed Description

Class for node sets in graph.

NodeGraphPart represents the set of nodes of all the graphs. It is built to be as light as possible and it implements its own NodeId factory. The set of NodeId is 0 ... ( bound-1) minus the NodeIds in holes.

Author

Pierre-Henri WUILLEMIN(_at_LIP6) & Christophe GONZALES(_at_AMU)

Usage example:

// create an empty node list
NodeGraphPart nodes1;
 
// add 2 elements
NodeId id_a=nodes1.addNode( );
NodeId id_b=nodes1.addNode( );
 
// checks if there exists a node with ID = 6
if ( !nodes1.exists( 6 ) ) std::cerr << "no node with ID 6" << std::endl;
 
// check if the set of nodes is empty
if ( !nodes1.empty() || ( nodes1.size() != 0 ) )
  std::cerr << "nodes1 is not empty" << std::endl;
 
// copy a set of nodes
NodeGraphPart nodes2 = nodes1, nodes3;
nodes3 = nodes1;
 
// remove elements from list3
nodes3.eraseNode( id_a );
nodes3.eraseNode( id_b );
 
// remove all the elements from the list
nodes1.clear();
 
for ( NodeGraphPart::iterator it=nodes2.beginNodes();
      it!=nodes2.endNodes();++it ) {
  std::cerr<<*it<<"  ";
}
 
std::cerr<<"list : "<<nodes2.listMapNodes(getDouble)<<std::endl;
 
std::cerr<<"hashmap : "<<nodes2.hashMapNodes(getDouble)<<std::endl;

Definition at line 263 of file nodeGraphPart.h.

Member Typedef Documentation

node_const_iterator

using gum::NodeGraphPart::node_const_iterator = NodeGraphPartIterator

types for STL compliance

Definition at line 268 of file nodeGraphPart.h.

node_const_iterator_safe

using gum::NodeGraphPart::node_const_iterator_safe = NodeGraphPartIteratorSafe

types for STL compliance

Definition at line 270 of file nodeGraphPart.h.

node_iterator

using gum::NodeGraphPart::node_iterator = NodeGraphPartIterator

types for STL compliance

Definition at line 267 of file nodeGraphPart.h.

node_iterator_safe

using gum::NodeGraphPart::node_iterator_safe = NodeGraphPartIteratorSafe

types for STL compliance

Definition at line 269 of file nodeGraphPart.h.

NodeConstIterator

using gum::NodeGraphPart::NodeConstIterator = NodeGraphPartIterator

Definition at line 277 of file nodeGraphPart.h.

NodeConstIteratorSafe

using gum::NodeGraphPart::NodeConstIteratorSafe = NodeGraphPartIteratorSafe

Definition at line 279 of file nodeGraphPart.h.

NodeIterator

using gum::NodeGraphPart::NodeIterator = NodeGraphPartIterator

Definition at line 276 of file nodeGraphPart.h.

NodeIteratorSafe

using gum::NodeGraphPart::NodeIteratorSafe = NodeGraphPartIteratorSafe

Definition at line 278 of file nodeGraphPart.h.

Constructor & Destructor Documentation

NodeGraphPart() [1/3]

gum::NodeGraphPart::NodeGraphPart ( Size holes_size = HashTableConst::default_size, bool holes_resize_policy = true )

explicit

default constructor

A NodeGrphPart does not store all its nodes. To be lighter in terms of memory consumption, it store its maximal NodeId and the set of NodeIds between 0 and this maximum that do not actually belong to the set of its nodes (the so-called set of holes). In practice, it turns out that the set of holes is most often very small.

Parameters

holes_size	the size of the hash table used to store all holes
holes_resize_policy	the resizing policy of this hash table

Definition at line 57 of file nodeGraphPart.cpp.

                                                                        :
      _holes_size_(holes_size), _holes_resize_policy_(holes_resize_policy),
      _endIteratorSafe_(*this), _boundVal_(0) {
    _holes_ = nullptr;
    GUM_CONSTRUCTOR(NodeGraphPart);
    _updateEndIteratorSafe_();
  }

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

Referenced by gum::DiGraph::DiGraph(), gum::DiGraph::DiGraph(), gum::DiGraph::DiGraph(), NodeGraphPart(), NodeGraphPart(), NodeGraphPart(), gum::UndiGraph::UndiGraph(), gum::UndiGraph::UndiGraph(), gum::UndiGraph::UndiGraph(), ~NodeGraphPart(), nodes(), gum::prm::gspan::Pattern::nodes(), operator=(), operator=(), operator==(), populateNodes(), and populateNodesFromProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

NodeGraphPart() [2/3]

gum::NodeGraphPart::NodeGraphPart

(

const NodeGraphPart &

s

)

copy constructor

Parameters

s	the NodeGraphPart to be copied

Definition at line 65 of file nodeGraphPart.cpp.

                                                     :
      _holes_size_(s._holes_size_), _holes_resize_policy_(s._holes_resize_policy_),
      _endIteratorSafe_(*this), _boundVal_(s._boundVal_) {
    _holes_ = nullptr;
 
    if (s._holes_) _holes_ = new NodeSet(*s._holes_);
 
    _names_ = s._cloneNames_();
 
    _updateEndIteratorSafe_();
 
    GUM_CONS_CPY(NodeGraphPart);
  }

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

Here is the call graph for this function:

NodeGraphPart() [3/3]

gum::NodeGraphPart::NodeGraphPart

(

NodeGraphPart &&

s

)

move constructor

Definition at line 79 of file nodeGraphPart.cpp.

                                                :
      _holes_(s._holes_), _names_(std::move(s._names_)), _holes_size_(s._holes_size_),
      _holes_resize_policy_(s._holes_resize_policy_), _endIteratorSafe_(*this),
      _boundVal_(s._boundVal_) {
    s._holes_    = nullptr;
    s._boundVal_ = 0;
 
    _updateEndIteratorSafe_();
 
    GUM_CONS_MOV(NodeGraphPart);
  }

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

Here is the call graph for this function:

~NodeGraphPart()

gum::NodeGraphPart::~NodeGraphPart ( )

virtual

destructor

Definition at line 91 of file nodeGraphPart.cpp.

                                {
    if (_holes_) delete _holes_;
 
    GUM_DESTRUCTOR(NodeGraphPart);
  }

References NodeGraphPart(), and _holes_.

Here is the call graph for this function:

Member Function Documentation

_addHole_()

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

private

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:

_clearNodes_()

void gum::NodeGraphPart::_clearNodes_ ( )

private

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

private

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 )

private

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

private

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

private

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

private

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:

addNode()

INLINE NodeId gum::NodeGraphPart::addNode ( )

virtual

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

)

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 )

virtual

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:

asNodeSet()

INLINE NodeSet gum::NodeGraphPart::asNodeSet

(

)

const

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

noexcept

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

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

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:

clear()

INLINE void gum::NodeGraphPart::clear ( )

virtual

alias for clearNodes

Reimplemented in gum::CliqueGraph, gum::DiGraph, gum::MixedGraph, gum::PAG, and gum::UndiGraph.

Definition at line 332 of file nodeGraphPart_inl.h.

{ _clearNodes_(); }

References _clearNodes_().

Referenced by populateNodes(), and populateNodesFromProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

clearNodes()

INLINE void gum::NodeGraphPart::clearNodes ( )

virtual

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:

dotNodeLabel()

std::string gum::NodeGraphPart::dotNodeLabel

(

NodeId

id

)

const

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

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:

emptyNodes()

INLINE bool gum::NodeGraphPart::emptyNodes

(

)

const

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

noexcept

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

noexcept

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:

eraseNode()

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

virtual

erase the node with the given id

If the NodeGraphPart does not contain the nodeId, then nothing is done. In particular, no exception is raised. However, the signal onNodeDeleted is fired only if a node is effectively removed.

Reimplemented in gum::CliqueGraph, gum::DiGraph, gum::MixedGraph, gum::PAG, and gum::UndiGraph.

Definition at line 309 of file nodeGraphPart_inl.h.

                                                        {
    if (!existsNode(node)) return;
 
    if (_names_ && _names_->existsFirst(node)) _names_->eraseFirst(node);
 
    _addHole_(node);
 
    GUM_EMIT1(onNodeDeleted, node);
  }

References _addHole_(), _names_, existsNode(), GUM_EMIT1, and onNodeDeleted.

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

Here is the call graph for this function:

Here is the caller graph for this function:

exists()

INLINE bool gum::NodeGraphPart::exists

(

const NodeId

id

)

const

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:

existsNode()

INLINE bool gum::NodeGraphPart::existsNode

(

const NodeId

id

)

const

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

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

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:

listMapNodes()

template<typename VAL>

List< VAL > gum::NodeGraphPart::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))

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

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

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

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

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

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

(

const NodeGraphPart &

p

)

copy operator

Parameters

p	the NodeGraphPart to be copied

Definition at line 220 of file nodeGraphPart_inl.h.

                                                                     {
    // avoid self assignment
    if (this != &p) { populateNodes(p); }
 
    return *this;
  }

References NodeGraphPart(), and populateNodes().

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

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [2/2]

INLINE NodeGraphPart & gum::NodeGraphPart::operator=

(

NodeGraphPart &&

p

)

move assignment operator

Definition at line 227 of file nodeGraphPart_inl.h.

                                                                {
    if (this != &p) {
      clearNodes();
      _holes_               = p._holes_;
      _holes_size_          = p._holes_size_;
      _holes_resize_policy_ = p._holes_resize_policy_;
      _boundVal_            = p._boundVal_;
      _names_               = std::move(p._names_);
      p._holes_             = nullptr;
      p._boundVal_          = 0;
      _updateEndIteratorSafe_();
      GUM_OP_MOV(NodeGraphPart);
    }
    return *this;
  }

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

Here is the call graph for this function:

operator==()

INLINE bool gum::NodeGraphPart::operator==

(

const NodeGraphPart &

p

)

const

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:

populateNodes()

void gum::NodeGraphPart::populateNodes

(

const NodeGraphPart &

s

)

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

)

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 )

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

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:

sizeNodes()

INLINE Size gum::NodeGraphPart::sizeNodes

(

)

const

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:

toString()

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

virtual

a function to display the set of nodes

Reimplemented in gum::CliqueGraph, gum::DiGraph, gum::MixedGraph, gum::PAG, and gum::UndiGraph.

Definition at line 140 of file nodeGraphPart.cpp.

                                          {
    std::string s     = "{";
    bool        first = true;
 
    const bool hasNames = (_names_ != nullptr);
    for (NodeId id = 0; id < _boundVal_; ++id) {
      if (_inHoles_(id)) continue;
 
      if (!first) s += ",";
      first = false;
 
      if (hasNames && _names_->existsFirst(id)) s += std::format("{}<{}>", id, _names_->second(id));
      else s += std::format("{}", id);
    }
 
    s += "}";
 
    return s;
  }

References _boundVal_, _inHoles_(), and _names_.

Referenced by gum::operator<<(), populateNodesFromProperty(), gum::DiGraph::toString(), gum::MixedGraph::toString(), gum::PAG::toString(), and gum::UndiGraph::toString().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

NodeGraphPartIterator

friend class NodeGraphPartIterator

friend

Definition at line 490 of file nodeGraphPart.h.

References NodeGraphPartIterator.

Referenced by begin(), end(), and NodeGraphPartIterator.

NodeGraphPartIteratorSafe

friend class NodeGraphPartIteratorSafe

friend

Definition at line 491 of file nodeGraphPart.h.

References _addHole_(), _clearNodes_(), _eraseHole_(), _inHoles_(), _sizeHoles_(), _updateEndIteratorSafe_(), and NodeGraphPartIteratorSafe.

Referenced by beginSafe(), endSafe(), and NodeGraphPartIteratorSafe.

Member Data Documentation

_boundVal_

NodeId gum::NodeGraphPart::_boundVal_

private

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

_endIteratorSafe_

NodeGraphPartIteratorSafe gum::NodeGraphPart::_endIteratorSafe_

private

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_

private

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_

private

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_

private

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_

private

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

onNodeAdded

Signaler< NodeId > gum::NodeGraphPart::onNodeAdded

Definition at line 281 of file nodeGraphPart.h.

Referenced by addNode(), and addNodeWithId().

onNodeDeleted

Signaler< NodeId > gum::NodeGraphPart::onNodeDeleted

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/parts/nodeGraphPart.h
• agrum/base/graphs/parts/nodeGraphPart.cpp
• agrum/base/graphs/parts/nodeGraphPart_inl.h