gum::ArcGraphPart Class Reference

Classes for directed edge sets. More...

#include <arcGraphPart.h>

Inheritance diagram for gum::ArcGraphPart:

Collaboration diagram for gum::ArcGraphPart:

Public Attributes
Signaler2< NodeId, NodeId >	onArcAdded
Signaler2< NodeId, NodeId >	onArcDeleted

Public Member Functions
Constructors / Destructors
	ArcGraphPart (Size arcs_size=HashTableConst::default_size, bool arcs_resize_policy=true)
	default constructor More...
	ArcGraphPart (const ArcGraphPart &s)
	copy constructor More...
virtual	~ArcGraphPart ()
	destructor More...
Operators
ArcGraphPart &	operator= (const ArcGraphPart &s)
	copy operator More...
bool	operator== (const ArcGraphPart &p) const
	tests whether two ArcGraphParts contain the same arcs More...
bool	operator!= (const ArcGraphPart &p) const
	tests whether two ArcGraphParts contain different arcs More...
Accessors/Modifiers
virtual void	addArc (const NodeId tail, const NodeId head)
	insert a new arc into the ArcGraphPart More...
virtual void	eraseArc (const Arc &arc)
	removes an arc from the ArcGraphPart More...
bool	existsArc (const Arc &arc) const
	indicates whether a given arc exists More...
bool	existsArc (const NodeId tail, const NodeId head) const
	indicates whether a given arc exists More...
bool	emptyArcs () const
	indicates wether the ArcGraphPart contains any arc More...
void	clearArcs ()
	removes all the arcs from the ArcGraphPart More...
Size	sizeArcs () const
	indicates the number of arcs stored within the ArcGraphPart More...
const ArcSet &	arcs () const
	returns the set of arcs stored within the ArcGraphPart More...
const NodeSet &	parents (const NodeId id) const
	returns the set of nodes with arc ingoing to a given node More...
const NodeSet &	children (const NodeId id) const
	returns the set of nodes with arc outgoing from a given node More...
void	eraseParents (const NodeId id)
	erase all the parents of a given node More...
void	unvirtualizedEraseParents (const NodeId id)
	same function as eraseParents but without any virtual call to an erase More...
void	eraseChildren (const NodeId id)
	removes all the children of a given node More...
void	unvirtualizedEraseChildren (const NodeId id)
	same function as eraseChildren but without any virtual call to an erase More...
const std::string	toString () const
	to friendly display the content of the ArcGraphPart More...
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)) More...
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) More...
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)) More...
const std::vector< NodeId >	directedPath (const NodeId node1, const NodeId node2) const
	returns a directed path from node1 to node2 belonging to the set of arcs More...
const std::vector< NodeId >	directedUnorientedPath (const NodeId node1, const NodeId node2) const
	returns an unoriented (directed) path from node1 to node2 in the arc set More...

Public Types
typedef ArcSetIterator	ArcIterator

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

Detailed Description

Classes for directed edge sets.

Author

Pierre-Henri WUILLEMIN and Christophe GONZALES

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 79 of file arcGraphPart.h.

Member Typedef Documentation

ArcIterator

typedef ArcSetIterator gum::ArcGraphPart::ArcIterator

Definition at line 81 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 39 of file arcGraphPart.cpp.

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

ArcGraphPart() [2/2]

gum::ArcGraphPart::ArcGraphPart

(

const ArcGraphPart &

s

)

copy constructor

Parameters

s	the ArcGraphPart to copy

Definition at line 44 of file arcGraphPart.cpp.

References __arcs, __children, __parents, gum::HashTable< Key, Val, Alloc >::capacity(), children(), GUM_EMIT2, and onArcAdded.

                                                  : __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& elt : pars) {
      NodeSet* newpar = new NodeSet(*elt.second);
      __parents.insert(elt.first, newpar);
    }

    // copy the sets of children
    const NodeProperty< NodeSet* >& children = s.__children;
    __children.resize(children.capacity());

    for (const auto& elt : children) {
      NodeSet* newchildren = new NodeSet(*elt.second);
      __children.insert(elt.first, 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());
      }
    }
  }

Here is the call graph for this function:

~ArcGraphPart()

gum::ArcGraphPart::~ArcGraphPart ( )

virtual

destructor

Definition at line 73 of file arcGraphPart.cpp.

References clearArcs().

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

Here is the call graph for this function:

Member Function Documentation

__checkChildren()

INLINE void gum::ArcGraphPart::__checkChildren ( const NodeId  id ) const

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

References __children.

Referenced by addArc(), and children().

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

Here is the caller graph for this function:

__checkParents()

INLINE void gum::ArcGraphPart::__checkParents ( const NodeId  id ) const

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

References __parents.

Referenced by addArc(), and parents().

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

Here is the caller 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 91 of file arcGraphPart_inl.h.

References eraseArc().

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

Here is the call 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 124 of file arcGraphPart_inl.h.

References eraseArc().

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

Here is the call graph for this function:

addArc()

INLINE void gum::ArcGraphPart::addArc ( const NodeId  tail, const 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::DiGraph, and gum::DAG.

Definition at line 67 of file arcGraphPart_inl.h.

References __arcs, __checkChildren(), __checkParents(), __children, __parents, GUM_EMIT2, gum::Set< Key, Alloc >::insert(), and onArcAdded.

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

                                                                       {
    Arc arc(tail, head);

    __arcs.insert(arc);
    __checkParents(head);
    __checkChildren(tail);
    __parents[head]->insert(tail);
    __children[tail]->insert(head);

    GUM_EMIT2(onArcAdded, tail, head);
  }

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

References __arcs.

Referenced by gum::MarkovBlanket::arcs(), gum::EssentialGraph::arcs(), gum::DAGmodel::arcs(), gum::prm::gspan::Pattern::arcs(), gum::learning::DAG2BNLearner< ALLOC >::createBN(), gum::DAG::moralGraph(), and gum::DiGraph::toDot().

{ return __arcs; }

Here is the caller graph for this function:

arcsProperty() [1/2]

template<typename VAL >

ArcProperty< VAL > gum::ArcGraphPart::arcsProperty	(	VAL(*)(const Arc &)	f,
		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.

arcsProperty() [2/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.

children()

INLINE const NodeSet & gum::ArcGraphPart::children

(

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

References __checkChildren(), and __children.

Referenced by gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__AR(), gum::EssentialGraph::__buildEssentialGraph(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__connect(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__directedPath(), gum::prm::gspan::Pattern::__expandCodeIsMinimal(), gum::prm::gspan::Pattern::__not_rec(), gum::prm::gspan::Pattern::__rec(), gum::InfluenceDiagram< GUM_SCALAR >::_getChildrenDecision(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::_initialize(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::_makeInferenceNodeToNeighbours(), ArcGraphPart(), gum::MarkovBlanket::children(), gum::EssentialGraph::children(), gum::DAGmodel::children(), directedUnorientedPath(), gum::InfluenceDiagram< GUM_SCALAR >::erase(), eraseChildren(), gum::InfluenceDiagram< GUM_SCALAR >::existsPathBetween(), gum::DiGraph::hasDirectedPath(), gum::prm::gspan::Pattern::isMinimal(), gum::MixedGraph::mixedUnorientedPath(), gum::BayesBall::relevantPotentials(), gum::dSeparation::relevantPotentials(), gum::prm::gspan::Pattern::remove(), gum::BayesBall::requisiteNodes(), gum::dSeparation::requisiteNodes(), gum::MarkovBlanket::toDot(), gum::EssentialGraph::toDot(), gum::InfluenceDiagram< GUM_SCALAR >::toDot(), gum::MixedGraph::toDot(), and unvirtualizedEraseChildren().

                                                                    {
    __checkChildren(id);
    return *(__children[id]);
  }

Here is the call graph for this function:

clearArcs()

void gum::ArcGraphPart::clearArcs

(

)

removes all the arcs from the ArcGraphPart

Definition at line 79 of file arcGraphPart.cpp.

References __arcs, __children, __parents, gum::Set< Key, Alloc >::clear(), GUM_EMIT2, and onArcDeleted.

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

                               {
    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();
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

directedPath()

const std::vector< NodeId > gum::ArcGraphPart::directedPath	(	const NodeId	node1,
		const 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 155 of file arcGraphPart.cpp.

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

Referenced by gum::learning::Miic::_orientation_latents().

                                                                                {
    // 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");
  }

Here is the call graph for this function:

Here is the caller graph for this function:

directedUnorientedPath()

const std::vector< NodeId > gum::ArcGraphPart::directedUnorientedPath	(	const NodeId	node1,
		const 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 198 of file arcGraphPart.cpp.

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

                                                                                {
    // 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");
  }

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

References __arcs, and gum::Set< Key, Alloc >::empty().

{ return __arcs.empty(); }

Here is the call graph for this function:

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

References __arcs, __children, __parents, gum::Set< Key, Alloc >::erase(), existsArc(), GUM_EMIT2, gum::Arc::head(), onArcDeleted, and gum::Arc::tail().

Referenced by gum::EssentialGraph::__buildEssentialGraph(), gum::prm::LayerGenerator< GUM_SCALAR >::__generateClassDag(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::__generateClassDag(), gum::learning::genericBNLearner::__learnDAG(), _eraseSetOfArcs(), gum::learning::Miic::_orientation_3off2(), gum::learning::Miic::_orientation_latents(), gum::learning::Miic::_orientation_miic(), gum::BayesNetFragment< GUM_SCALAR >::_uninstallArc(), _unvirtualizedEraseSetOfArcs(), gum::DAGCycleDetector::eraseArc(), gum::InfluenceDiagram< GUM_SCALAR >::eraseArc(), eraseChildren(), eraseParents(), gum::learning::GreedyHillClimbing::learnStructure(), gum::learning::LocalSearchWithTabuList::learnStructure(), gum::prm::gspan::Pattern::pop_back(), gum::BayesNet< double >::reverseArc(), unvirtualizedEraseChildren(), and unvirtualizedEraseParents().

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

Here is the call graph for this function:

Here is the caller graph for this function:

eraseChildren()

INLINE void gum::ArcGraphPart::eraseChildren

(

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

References __children, gum::Set< Key, Alloc >::beginSafe(), children(), gum::Set< Key, Alloc >::endSafe(), and eraseArc().

                                                         {
    if (__children.exists(id)) {
      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 vritualized
        // arc removal function
        eraseArc(Arc(id, *iter));
      }
    }
  }

Here is the call graph for this function:

eraseParents()

INLINE void gum::ArcGraphPart::eraseParents

(

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

References __parents, gum::Set< Key, Alloc >::beginSafe(), gum::Set< Key, Alloc >::endSafe(), eraseArc(), and parents().

                                                        {
    if (__parents.exists(id)) {
      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));
      }
    }
  }

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

References __arcs, and gum::Set< Key, Alloc >::contains().

Referenced by gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__AorR(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__AR(), gum::MarkovBlanket::__buildMarkovBlanket(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__connect(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__directedPath(), gum::learning::Miic::__existsDirectedPath(), gum::prm::LayerGenerator< GUM_SCALAR >::__generateClassDag(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::__generateClassDag(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__jump_multi(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__jump_poly(), gum::prm::gspan::Pattern::__not_rec(), gum::prm::gspan::Pattern::__rec(), gum::learning::Miic::_orientation_3off2(), gum::learning::Miic::_orientation_latents(), gum::learning::Miic::_orientation_miic(), gum::learning::Miic::_updateProbaTriples(), gum::DAGCycleDetector::addArc(), eraseArc(), gum::DAGCycleDetector::eraseArc(), gum::InfluenceDiagram< GUM_SCALAR >::eraseArc(), and gum::prm::gspan::Pattern::exists().

                                                          {
    return __arcs.contains(arc);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

existsArc() [2/2]

INLINE bool gum::ArcGraphPart::existsArc	(	const NodeId	tail,
		const 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 45 of file arcGraphPart_inl.h.

References __parents.

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

listMapArcs()

template<typename VAL >

List< VAL > gum::ArcGraphPart::listMapArcs

(

VAL(*)(const Arc &)

f

)

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

INLINE bool gum::ArcGraphPart::operator!=

(

const ArcGraphPart &

p

)

const

tests whether two ArcGraphParts contain different arcs

Parameters

p	the ArcGraphPart that we compare with this

Definition at line 157 of file arcGraphPart_inl.h.

References __arcs.

                                                                  {
    return __arcs != p.__arcs;
  }

operator=()

ArcGraphPart & gum::ArcGraphPart::operator=

(

const ArcGraphPart &

s

)

copy operator

Parameters

s	the ArcGraphPart to copy

Definition at line 102 of file arcGraphPart.cpp.

References __arcs, __children, __parents, clearArcs(), GUM_EMIT2, and onArcAdded.

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

                                                             {
    // 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& elt : s.__parents) {
        NodeSet* newpar = new NodeSet(*elt.second);
        __parents.insert(elt.first, newpar);
      }

      // copy the sets of children
      __children.resize(s.__children.capacity());

      for (const auto& elt : s.__children) {
        NodeSet* newchildren = new NodeSet(*elt.second);
        __children.insert(elt.first, newchildren);
      }

      if (onArcAdded.hasListener()) {
        for (const auto& arc : __arcs) {
          GUM_EMIT2(onArcAdded, arc.tail(), arc.head());
        }
      }
    }

    return *this;
  }

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

References __arcs.

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

                                                                  {
    return __arcs == p.__arcs;
  }

Here is the caller graph for this function:

parents()

INLINE const NodeSet & gum::ArcGraphPart::parents

(

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

References __checkParents(), and __parents.

Referenced by gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__AR(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__connect(), gum::learning::Miic::__existsDirectedPath(), gum::prm::gspan::Pattern::__expandCodeIsMinimal(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::__generateClass(), gum::prm::LayerGenerator< GUM_SCALAR >::__generateClassDag(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::__generateClassDag(), gum::prm::LayerGenerator< GUM_SCALAR >::__generateClasses(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::__generateCluster(), gum::prm::gspan::Pattern::__not_rec(), gum::prm::gspan::Pattern::__rec(), gum::EssentialGraph::__strongly_protected(), gum::InfluenceDiagram< GUM_SCALAR >::_copyTables(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::_initialize(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::_makeInferenceNodeToNeighbours(), gum::InfluenceDiagram< GUM_SCALAR >::_moralGraph(), gum::learning::Miic::_orientation_miic(), gum::learning::Miic::_propagatesHead(), gum::BarrenNodesFinder::barrenNodes(), directedPath(), directedUnorientedPath(), gum::learning::BNDatabaseGenerator< GUM_SCALAR >::drawSamples(), eraseParents(), gum::InfluenceDiagram< GUM_SCALAR >::getPartialTemporalOrder(), gum::prm::gspan::Pattern::isMinimal(), gum::learning::Miic::learnStructure(), gum::MixedGraph::mixedOrientedPath(), gum::MixedGraph::mixedUnorientedPath(), gum::DAG::moralGraph(), gum::prm::gspan::DFSTree< GUM_SCALAR >::parent(), gum::MarkovBlanket::parents(), gum::EssentialGraph::parents(), gum::DAGmodel::parents(), gum::BayesBall::relevantPotentials(), gum::dSeparation::relevantPotentials(), gum::prm::gspan::Pattern::remove(), gum::BayesBall::requisiteNodes(), gum::dSeparation::requisiteNodes(), gum::prm::gspan::Pattern::rightmostPath(), and unvirtualizedEraseParents().

                                                                   {
    __checkParents(id);
    return *(__parents[id]);
  }

Here is the call graph for this function:

sizeArcs()

INLINE Size gum::ArcGraphPart::sizeArcs

(

)

const

indicates the number of arcs stored within the ArcGraphPart

Definition at line 37 of file arcGraphPart_inl.h.

References __arcs, and gum::Set< Key, Alloc >::size().

Referenced by gum::MarkovBlanket::sizeArcs(), gum::EssentialGraph::sizeArcs(), gum::DAGmodel::sizeArcs(), gum::prm::gspan::Pattern::sizeArcs(), and gum::InfluenceDiagram< GUM_SCALAR >::toString().

{ return __arcs.size(); }

Here is the call graph for this function:

Here is the caller graph for this function:

toString()

const std::string gum::ArcGraphPart::toString

(

)

const

to friendly display the content of the ArcGraphPart

Definition at line 135 of file arcGraphPart.cpp.

References __arcs.

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

                                               {
    std::stringstream s;
    bool              first = true;
    s << "{";

    for (const auto& arc : __arcs) {
      if (first) {
        first = false;
      } else {
        s << ",";
      }

      s << arc;
    }

    s << "}";

    return s.str();
  }

Here is the caller graph for this function:

unvirtualizedEraseChildren()

INLINE void gum::ArcGraphPart::unvirtualizedEraseChildren

(

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

References __children, gum::Set< Key, Alloc >::beginSafe(), children(), gum::Set< Key, Alloc >::endSafe(), and eraseArc().

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

                                                                      {
    if (__children.exists(id)) {
      NodeSet& children = *(__children[id]);

      for (auto iter = children.beginSafe();   // safe iterator needed here
           iter != children.endSafe();
           ++iter) {
        ArcGraphPart::eraseArc(Arc(id, *iter));
      }
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

unvirtualizedEraseParents()

INLINE void gum::ArcGraphPart::unvirtualizedEraseParents

(

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

References __parents, gum::Set< Key, Alloc >::beginSafe(), gum::Set< Key, Alloc >::endSafe(), eraseArc(), and parents().

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

                                                                     {
    if (__parents.exists(id)) {
      NodeSet& parents = *(__parents[id]);

      for (auto iter = parents.beginSafe();   // safe iterator needed here
           iter != parents.endSafe();
           ++iter) {
        ArcGraphPart::eraseArc(Arc(*iter, id));
      }
    }
  }

Here is the call graph for this function:

Here is the caller 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 269 of file arcGraphPart.h.

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

__children

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

mutableprivate

for each arc, the set of its children

Definition at line 275 of file arcGraphPart.h.

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

__parents

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

mutableprivate

for each arc, the sets of its parents

Definition at line 272 of file arcGraphPart.h.

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

onArcAdded

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

Definition at line 83 of file arcGraphPart.h.

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

onArcDeleted

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

Definition at line 84 of file arcGraphPart.h.

Referenced by clearArcs(), and eraseArc().

---

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

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