gum::ArcGraphPart Class Reference

Classes for directed edge sets. More...

#include <arcGraphPart.h>

Inheritance diagram for gum::ArcGraphPart:

Collaboration diagram for gum::ArcGraphPart:

Public Types
using	ArcIterator = ArcSetIterator

Public Member Functions
Constructors / Destructors
	ArcGraphPart (Size arcs_size=HashTableConst::default_size, bool arcs_resize_policy=true)
	default constructor
	ArcGraphPart (const ArcGraphPart &s)
	copy constructor
virtual	~ArcGraphPart ()
	destructor
Operators
ArcGraphPart &	operator= (const ArcGraphPart &s)
	copy operator
bool	operator== (const ArcGraphPart &p) const
	tests whether two ArcGraphParts contain the same arcs
Accessors/Modifiers
virtual void	addArc (NodeId tail, NodeId head)
	insert a new arc into the ArcGraphPart
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	family (NodeId id) const
	returns the set of nodes which consists in the node and its parents
NodeSet	descendants (NodeId id) const
	returns the set of nodes with directed path outgoing from a given node
NodeSet	ancestors (NodeId id) const
	returns the set of nodes with directed path ingoing to a given node
NodeSet	children (const NodeSet &ids) const
	returns the set of children of a set of nodes
NodeSet	parents (const NodeSet &ids) const
	returns the set of parents of a set of nodes
NodeSet	family (const NodeSet &ids) const
	returns the set of family nodes 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
std::string	toString () const
	to friendly display the content of the ArcGraphPart
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))
std::vector< NodeId >	directedPath (NodeId node1, NodeId node2) const
	returns a directed path from node1 to node2 belonging to the set of arcs
std::vector< NodeId >	directedUnorientedPath (NodeId node1, NodeId node2) const
	returns an unoriented (directed) path from node1 to node2 in the arc set

Public Attributes
Signaler2< NodeId, NodeId >	onArcAdded
Signaler2< 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	_checkParents_ (NodeId id)
	when the ArcGraphPart contains no arc ingoing into a given node, this function adds an empty set entry to parents[id]
void	_checkChildren_ (NodeId id)
	when the ArcGraphPart contains no arc outgoing from a given node, this function adds an empty set entry to children[id]

Private Attributes
Set< Arc >	_arcs_
	the set of all the arcs contained within the ArcGraphPart
NodeProperty< NodeSet * >	_parents_
	for each arc, the sets of its parents
NodeProperty< NodeSet * >	_children_
	for each arc, the set of its children

Detailed Description

Classes for directed edge sets.

Author

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

Usage example:

ArcGraphPart arcs1,arcs2,arcs3;
 
// insert elements into arcs1
arcs1.addArc( 2,3 );
arcs1.addArc( 5,3 );
 
// copy arcs1 into arcs2
arcs2=arcs1;
 
// remove some elements from arcs1
arcs1.eraseArc( Arc( 5,3 ) );
arcs1.eraseArc( arc );
 
if ( arcs1.empty() ) std::cerr<<" arcs1 is empty"<<std::endl;
 
// checks whether a given arc exists
if ( arcs2.existArc( arc ) )
  cerr << "set contains " << arc << endl;
 
if ( arcs2.existArc( 5,3 ) )
  cerr << "set contains " << arc << endl;
 
std::cerr<<arcs2.toString()<<std::endl;
 
std::cerr<<arcs2.parents( 3 )<<std::endl;
 
std::cerr<<arcs2.children( 2 )<<std::endl;
 
std::cerr<<std::endl<<std::endl;
 
std::cerr<<std::endl<<std::endl;

Definition at line 98 of file arcGraphPart.h.

Member Typedef Documentation

ArcIterator

using gum::ArcGraphPart::ArcIterator = ArcSetIterator

Definition at line 100 of file arcGraphPart.h.

Constructor & Destructor Documentation

ArcGraphPart() [1/2]

gum::ArcGraphPart::ArcGraphPart ( Size arcs_size = HashTableConst::default_size, bool arcs_resize_policy = true )

explicit

default constructor

Parameters

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 58 of file arcGraphPart.cpp.

                                                                    :
      _arcs_(arcs_size, arcs_resize_policy) {
    GUM_CONSTRUCTOR(ArcGraphPart);
  }

References ArcGraphPart(), and _arcs_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

ArcGraphPart() [2/2]

gum::ArcGraphPart::ArcGraphPart

(

const ArcGraphPart &

s

)

copy constructor

Parameters

s	the ArcGraphPart to copy

Definition at line 63 of file arcGraphPart.cpp.

                                                  : _arcs_(s._arcs_) {
    GUM_CONS_CPY(ArcGraphPart);
 
    // copy the sets of parents
    const NodeProperty< NodeSet* >& pars = s._parents_;
    _parents_.resize(pars.capacity());
 
    for (const auto& [key, nodeset]: pars) {
      NodeSet* newpar = new NodeSet(*nodeset);
      _parents_.insert(key, newpar);
    }
 
    // copy the sets of children
    const NodeProperty< NodeSet* >& children = s._children_;
    _children_.resize(children.capacity());
 
    for (const auto& [key, nodeset]: children) {
      NodeSet* newchildren = new NodeSet(*nodeset);
      _children_.insert(key, newchildren);
    }
 
    // send signals to indicate that there are new arcs
    if (onArcAdded.hasListener()) {
      for (const auto& arc: _arcs_) {
        GUM_EMIT2(onArcAdded, arc.tail(), arc.head());
      }
    }
  }

References ArcGraphPart(), _arcs_, _children_, _parents_, gum::HashTable< Key, Val >::capacity(), children(), GUM_EMIT2, and onArcAdded.

Here is the call graph for this function:

~ArcGraphPart()

gum::ArcGraphPart::~ArcGraphPart ( )

virtual

destructor

Definition at line 92 of file arcGraphPart.cpp.

                              {
    GUM_DESTRUCTOR(ArcGraphPart);
    // be sure to deallocate all the parents and children sets
    clearArcs();
  }

References ArcGraphPart(), and clearArcs().

Here is the call graph for this function:

Member Function Documentation

_checkChildren_()

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

private

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

private

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

addArc()

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

virtual

insert a new arc into the ArcGraphPart

Parameters

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

Warning

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

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

Definition at line 114 of file arcGraphPart_inl.h.

                                                           {
    Arc arc(tail, head);
 
    _arcs_.insert(arc);
    _checkParents_(head);
    _checkChildren_(tail);
    _parents_[head]->insert(tail);
    _children_[tail]->insert(head);
 
    GUM_EMIT2(onArcAdded, tail, head);
  }

References _arcs_, _checkChildren_(), _checkParents_(), _children_, _parents_, GUM_EMIT2, and onArcAdded.

Referenced by gum::DiGraph::addArc().

Here is the call graph for this function:

Here is the caller graph for this function:

ancestors()

NodeSet gum::ArcGraphPart::ancestors

(

NodeId

id

)

const

returns the set of nodes with directed path ingoing to a given node

Note that the set of nodes returned may be empty if no path within the ArcGraphPart is ingoing to the given node.

Parameters

id	the node which is the head of a directed path with the returned nodes

Definition at line 191 of file arcGraphPart.cpp.

                                                 {
    NodeSet res;
    NodeSet tmp;
    for (auto next: parents(id))
      tmp.insert(next);
 
    while (!tmp.empty()) {
      auto current = *(tmp.begin());
      tmp.erase(current);
      res.insert(current);
      for (auto next: parents(current)) {
        if (!tmp.contains(next) && !res.contains(next)) { tmp.insert(next); }
      }
    }
    return res;
  }

References gum::Set< Key >::begin(), gum::Set< Key >::contains(), gum::Set< Key >::empty(), gum::Set< Key >::erase(), gum::Set< Key >::insert(), and parents().

Referenced by gum::DAGmodel::ancestors().

Here is the call graph for this function:

Here is the caller graph for this function:

arcs()

INLINE const ArcSet & gum::ArcGraphPart::arcs

(

)

const

returns the set of arcs stored within the ArcGraphPart

Definition at line 59 of file arcGraphPart_inl.h.

{ return _arcs_; }

References _arcs_.

Referenced by gum::EssentialGraph::_buildEssentialGraph_(), gum::prm::ClassBayesNet< GUM_SCALAR >::_init_(), gum::prm::gspan::Pattern::arcs(), gum::learning::SimpleMiic::learnStructure(), gum::DAG::moralGraph(), gum::PDAG::moralGraph(), gum::MeekRules::propagateToCPDAG(), gum::MeekRules::propagateToDAG(), 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

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

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.

children() [1/2]

INLINE NodeSet gum::ArcGraphPart::children

(

const NodeSet &

ids

)

const

returns the set of children of a set of nodes

Definition at line 86 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::prm::gspan::Pattern::_expandCodeIsMinimal_(), gum::prm::SVE< GUM_SCALAR >::_initElimOrder_(), gum::prm::SVED< GUM_SCALAR >::_initElimOrder_(), gum::DAG::_minimalCondSetVisitDn_(), gum::DAG::_minimalCondSetVisitUp_(), gum::prm::gspan::Pattern::_not_rec_(), gum::MeekRules::_propagatesOrientationInChainOfRemainingEdges_(), gum::prm::gspan::Pattern::_rec_(), gum::BarrenNodesFinder::barrenNodes(), gum::MixedGraph::boundary(), children(), descendants(), directedUnorientedPath(), eraseChildren(), gum::DiGraph::hasDirectedPath(), gum::PDAG::hasMixedReallyOrientedPath(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::initialize_(), gum::prm::PRMClassElementContainer< double >::isInputNode(), gum::prm::gspan::Pattern::isMinimal(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::makeInferenceNodeToNeighbours_(), gum::DAG::minimalCondSet(), gum::MixedGraph::mixedUnorientedPath(), gum::learning::SimpleMiic::propagatesOrientationInChainOfRemainingEdges_(), gum::rec_hasMixedReallyOrientedPath(), gum::BayesBall::relevantTensors(), gum::dSeparationAlgorithm::relevantTensors(), gum::prm::gspan::Pattern::remove(), gum::BayesBall::requisiteNodes(), 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

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 109 of file arcGraphPart_inl.h.

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

References _children_, and gum::emptyNodeSet.

clearArcs()

void gum::ArcGraphPart::clearArcs

(

)

removes all the arcs from the ArcGraphPart

Definition at line 98 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=(), and gum::MixedGraph::operator=().

Here is the caller graph for this function:

descendants()

NodeSet gum::ArcGraphPart::descendants

(

NodeId

id

)

const

returns the set of nodes with directed path outgoing from a given node

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

Parameters

id	the node which is the tail of a directed path with the returned nodes

Definition at line 174 of file arcGraphPart.cpp.

                                                   {
    NodeSet res;
    NodeSet tmp;
    for (auto next: children(id))
      tmp.insert(next);
 
    while (!tmp.empty()) {
      auto current = *(tmp.begin());
      tmp.erase(current);
      res.insert(current);
      for (auto next: children(current)) {
        if (!tmp.contains(next) && !res.contains(next)) { tmp.insert(next); }
      }
    }
    return res;
  }

References gum::Set< Key >::begin(), children(), gum::Set< Key >::contains(), gum::Set< Key >::empty(), gum::Set< Key >::erase(), and gum::Set< Key >::insert().

Referenced by gum::DAGmodel::descendants().

Here is the call graph for this function:

Here is the caller graph for this function:

directedPath()

std::vector< NodeId > gum::ArcGraphPart::directedPath	(	NodeId	node1,
		NodeId	node2 ) const

returns a directed path from node1 to node2 belonging to the set of arcs

Parameters

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

Exceptions

NotFound

exception is raised if no path can be found between the two nodes

Definition at line 208 of file arcGraphPart.cpp.

                                                                           {
    // not recursive version => use a FIFO for simulating the recursion
    List< NodeId > nodeFIFO;
    nodeFIFO.pushBack(n2);
 
    // mark[node] = successor if visited, else mark[node] does not exist
    NodeProperty< NodeId > mark;
    mark.insert(n2, n2);
 
    NodeId current;
 
    while (!nodeFIFO.empty()) {
      current = nodeFIFO.front();
      nodeFIFO.popFront();
 
      // check the parents
 
      for (const auto new_one: parents(current)) {
        if (mark.exists(new_one))   // if this node is already marked, do not
          continue;                 // check it again
 
        mark.insert(new_one, current);
 
        if (new_one == n1) {
          std::vector< NodeId > v;
 
          for (current = n1; current != n2; current = mark[current])
            v.push_back(current);
 
          v.push_back(n2);
 
          return v;
        }
 
        nodeFIFO.pushBack(new_one);
      }
    }
 
    GUM_ERROR(NotFound, "no path found")
  }

References gum::List< Val >::empty(), gum::HashTable< Key, Val >::exists(), gum::List< Val >::front(), GUM_ERROR, gum::HashTable< Key, Val >::insert(), parents(), gum::List< Val >::popFront(), and gum::List< Val >::pushBack().

Referenced by gum::learning::SimpleMiic::orientationLatents_().

Here is the call graph for this function:

Here is the caller graph for this function:

directedUnorientedPath()

std::vector< NodeId > gum::ArcGraphPart::directedUnorientedPath	(	NodeId	node1,
		NodeId	node2 ) const

returns an unoriented (directed) path from node1 to node2 in the arc set

Parameters

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

Exceptions

NotFound

exception is raised if no path can be found between the two nodes

Definition at line 249 of file arcGraphPart.cpp.

                                                                                     {
    // not recursive version => use a FIFO for simulating the recursion
    List< NodeId > nodeFIFO;
    nodeFIFO.pushBack(n2);
 
    // mark[node] = successor if visited, else mark[node] does not exist
    NodeProperty< NodeId > mark;
    mark.insert(n2, n2);
 
    NodeId current;
 
    while (!nodeFIFO.empty()) {
      current = nodeFIFO.front();
      nodeFIFO.popFront();
 
      // check the parents
      for (const auto new_one: parents(current)) {
        if (mark.exists(new_one))   // the node has already been visited
          continue;
 
        mark.insert(new_one, current);
 
        if (new_one == n1) {
          std::vector< NodeId > v;
 
          for (current = n1; current != n2; current = mark[current])
            v.push_back(current);
 
          v.push_back(n2);
 
          return v;
        }
 
        nodeFIFO.pushBack(new_one);
      }
 
      // check the children
      for (const auto new_one: children(current)) {
        if (mark.exists(new_one))   // the node has already been visited
          continue;
 
        mark.insert(new_one, current);
 
        if (new_one == n1) {
          std::vector< NodeId > v;
 
          for (current = n1; current != n2; current = mark[current])
            v.push_back(current);
 
          v.push_back(n2);
 
          return v;
        }
 
        nodeFIFO.pushBack(new_one);
      }
    }
 
    GUM_ERROR(NotFound, "no path found")
  }

References children(), gum::List< Val >::empty(), gum::HashTable< Key, Val >::exists(), gum::List< Val >::front(), GUM_ERROR, gum::HashTable< Key, Val >::insert(), parents(), gum::List< Val >::popFront(), and gum::List< Val >::pushBack().

Here is the call graph for this function:

emptyArcs()

INLINE bool gum::ArcGraphPart::emptyArcs

(

)

const

indicates wether the ArcGraphPart contains any arc

Definition at line 55 of file arcGraphPart_inl.h.

{ return _arcs_.empty(); }

References _arcs_.

eraseArc()

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

virtual

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 126 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::BarrenNodesFinder::barrenNodes(), eraseChildren(), eraseParents(), eraseSetOfArcs_(), gum::learning::IBNLearner::learnDag_(), gum::learning::GreedyHillClimbing::learnStructure(), gum::learning::LocalSearchWithTabuList::learnStructure(), gum::learning::SimpleMiic::learnStructure(), gum::learning::SimpleMiic::orientationLatents_(), gum::learning::Miic::orientationMiic_(), gum::learning::SimpleMiic::orientationMiic_(), gum::learning::Miic::orientDoubleHeadedArcs_(), gum::prm::gspan::Pattern::pop_back(), unvirtualizedEraseChildren(), unvirtualizedEraseParents(), and unvirtualizedEraseSetOfArcs_().

Here is the call graph for this function:

Here is the caller graph for this function:

eraseChildren()

INLINE void gum::ArcGraphPart::eraseChildren

(

NodeId

id

)

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

eraseParents()

INLINE void gum::ArcGraphPart::eraseParents

(

NodeId

id

)

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

protected

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 139 of file arcGraphPart_inl.h.

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

References eraseArc().

Here is the call graph for this function:

existsArc() [1/2]

INLINE bool gum::ArcGraphPart::existsArc

(

const Arc &

arc

)

const

indicates whether a given arc exists

Parameters

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

Definition at line 61 of file arcGraphPart_inl.h.

{ return _arcs_.contains(arc); }

References _arcs_.

Referenced by gum::learning::Miic::_existsDirectedPath_(), gum::learning::SimpleMiic::_existsDirectedPath_(), gum::MeekRules::_existsDirectedPath_(), gum::learning::Miic::_existsNonTrivialDirectedPath_(), gum::learning::SimpleMiic::_existsNonTrivialDirectedPath_(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::_generateClassDag_(), gum::prm::LayerGenerator< GUM_SCALAR >::_generateClassDag_(), gum::prm::gspan::Pattern::_not_rec_(), gum::learning::Miic::_orientingVstructureMiic_(), gum::learning::SimpleMiic::_orientingVstructureMiic_(), gum::MeekRules::_propagatesOrientationInChainOfRemainingEdges_(), gum::prm::gspan::Pattern::_rec_(), gum::EssentialGraph::_strongly_protected_(), eraseArc(), gum::prm::gspan::Pattern::exists(), gum::learning::SimpleMiic::orientationLatents_(), gum::learning::Miic::updateProbaTriples_(), and gum::learning::SimpleMiic::updateProbaTriples_().

Here is the caller graph for this function:

existsArc() [2/2]

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

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 63 of file arcGraphPart_inl.h.

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

References _parents_.

family() [1/2]

INLINE NodeSet gum::ArcGraphPart::family

(

const NodeSet &

ids

)

const

returns the set of family nodes of a set of nodes

Definition at line 102 of file arcGraphPart_inl.h.

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

References family().

Here is the call graph for this function:

family() [2/2]

INLINE NodeSet gum::ArcGraphPart::family

(

NodeId

id

)

const

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

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

Parameters

id	the node which is the tail of a directed path with the returned nodes

Definition at line 80 of file arcGraphPart_inl.h.

                                                     {
    NodeSet res{id};
    return res + parents(id);
  }

References parents().

Referenced by family().

Here is the call graph for this function:

Here is the caller graph for this function:

listMapArcs()

template<typename VAL>

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

Parameters

f	a function assigning a VAL to any arc

operator=()

ArcGraphPart & gum::ArcGraphPart::operator=

(

const ArcGraphPart &

s

)

copy operator

Parameters

s	the ArcGraphPart to copy

Definition at line 121 of file arcGraphPart.cpp.

                                                           {
    // avoid self assignment
    if (this != &s) {
      // copy the arcs
      clearArcs();
      _arcs_ = s._arcs_;
 
      // copy the sets of parents
      _parents_.resize(s._parents_.capacity());
 
      for (const auto& [key, nodeset]: s._parents_) {
        NodeSet* newpar = new NodeSet(*nodeset);
        _parents_.insert(key, newpar);
      }
 
      // copy the sets of children
      _children_.resize(s._children_.capacity());
 
      for (const auto& [key, nodeset]: s._children_) {
        NodeSet* newchildren = new NodeSet(*nodeset);
        _children_.insert(key, newchildren);
      }
 
      if (onArcAdded.hasListener()) {
        for (const auto& arc: _arcs_) {
          GUM_EMIT2(onArcAdded, arc.tail(), arc.head());
        }
      }
    }
 
    return *this;
  }

References ArcGraphPart(), _arcs_, _children_, _parents_, clearArcs(), GUM_EMIT2, and onArcAdded.

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

INLINE bool gum::ArcGraphPart::operator==

(

const ArcGraphPart &

p

)

const

tests whether two ArcGraphParts contain the same arcs

Parameters

p	the ArcGraphPart that we compare with this

Definition at line 201 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:

parents() [1/2]

INLINE NodeSet gum::ArcGraphPart::parents

(

const NodeSet &

ids

)

const

returns the set of parents of a set of nodes

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

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 75 of file arcGraphPart_inl.h.

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

References _parents_, and gum::emptyNodeSet.

Referenced by gum::MeekRules::_complete_(), gum::MeekRules::_critereMinParents_(), gum::learning::Miic::_existsDirectedPath_(), gum::learning::SimpleMiic::_existsDirectedPath_(), gum::MeekRules::_existsDirectedPath_(), gum::learning::Miic::_existsNonTrivialDirectedPath_(), gum::learning::SimpleMiic::_existsNonTrivialDirectedPath_(), 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::MeekRules::_isOrientable_(), gum::DAG::_minimalCondSetVisitDn_(), gum::DAG::_minimalCondSetVisitUp_(), gum::prm::gspan::Pattern::_not_rec_(), gum::MeekRules::_orientDoubleHeadedArcs_(), gum::MeekRules::_propagates_(), gum::learning::Miic::_propagatingOrientationMiic_(), gum::learning::SimpleMiic::_propagatingOrientationMiic_(), gum::prm::gspan::Pattern::_rec_(), gum::EssentialGraph::_strongly_protected_(), ancestors(), gum::BarrenNodesFinder::barrenNodes(), gum::MixedGraph::boundary(), directedPath(), directedUnorientedPath(), eraseParents(), family(), gum::MixedGraph::hasMixedOrientedPath(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::initialize_(), gum::prm::PRMClassElementContainer< double >::isInputNode(), gum::learning::Miic::isMaxIndegree_(), gum::prm::gspan::Pattern::isMinimal(), gum::learning::SimpleMiic::isOrientable_(), gum::learning::SimpleMiic::learnPDAG(), gum::learning::SimpleMiic::learnStructure(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::makeInferenceNodeToNeighbours_(), gum::DAG::minimalCondSet(), gum::MixedGraph::mixedOrientedPath(), gum::MixedGraph::mixedUnorientedPath(), gum::DAG::moralGraph(), gum::PDAG::moralGraph(), gum::DAG::moralizedAncestralGraph(), gum::learning::Miic::orientDoubleHeadedArcs_(), gum::prm::gspan::DFSTree< GUM_SCALAR >::parent(), gum::prm::gspan::DFSTree< GUM_SCALAR >::parent(), parents(), gum::rec_ancestral(), gum::BayesBall::relevantTensors(), gum::dSeparationAlgorithm::relevantTensors(), gum::prm::gspan::Pattern::remove(), gum::BayesBall::requisiteNodes(), gum::dSeparationAlgorithm::requisiteNodes(), gum::prm::gspan::Pattern::rightmostPath(), gum::DAGCycleDetector::setDAG(), and unvirtualizedEraseParents().

sizeArcs()

INLINE Size gum::ArcGraphPart::sizeArcs

(

)

const

indicates the number of arcs stored within the ArcGraphPart

Definition at line 57 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:

toString()

std::string gum::ArcGraphPart::toString

(

)

const

to friendly display the content of the ArcGraphPart

Definition at line 154 of file arcGraphPart.cpp.

                                         {
    std::stringstream s;
    bool              first = true;
    s << "{";
 
    for (const auto& arc: _arcs_) {
      if (first) {
        first = false;
      } else {
        s << ",";
      }
 
      s << arc;
    }
 
    s << "}";
 
    return s.str();
  }

References _arcs_.

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

Here is the caller graph for this function:

unvirtualizedEraseChildren()

INLINE void gum::ArcGraphPart::unvirtualizedEraseChildren

(

NodeId

id

)

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

)

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

protected

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

private

the set of all the arcs contained within the ArcGraphPart

Definition at line 316 of file arcGraphPart.h.

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

_children_

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

private

for each arc, the set of its children

Definition at line 322 of file arcGraphPart.h.

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

_parents_

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

private

for each arc, the sets of its parents

Definition at line 319 of file arcGraphPart.h.

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

onArcAdded

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

Definition at line 102 of file arcGraphPart.h.

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

onArcDeleted

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

Definition at line 103 of file arcGraphPart.h.

Referenced by clearArcs(), and eraseArc().

---

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

• agrum/base/graphs/parts/arcGraphPart.h
• agrum/base/graphs/parts/arcGraphPart.cpp
• agrum/base/graphs/parts/arcGraphPart_inl.h