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 Attributes
Signaler1< NodeId >	onNodeAdded
Signaler1< NodeId >	onNodeDeleted

Public Member Functions
Constructors / Destructors
	NodeGraphPart (Size holes_size=HashTableConst::default_size, bool holes_resize_policy=true)
	default constructor More...
	NodeGraphPart (const NodeGraphPart &s)
	copy constructor More...
virtual	~NodeGraphPart ()
	destructor More...
Operators
NodeGraphPart &	operator= (const NodeGraphPart &p)
	copy operator More...
bool	operator== (const NodeGraphPart &p) const
	check whether two NodeGraphParts contain the same nodes More...
bool	operator!= (const NodeGraphPart &p) const
	check whether two NodeGraphParts contain different nodes More...
Accessors/Modifiers
void	populateNodes (const NodeGraphPart &s)
	populateNodes clears *this and fills it with the same nodes as "s" More...
template<typename T >
void	populateNodesFromProperty (const NodeProperty< T > &h)
	populateNodesFromProperty clears *this and fills it with the keys of "h" More...
NodeId	nextNodeId () const
	returns a new node id, not yet used by any node More...
virtual NodeId	addNode ()
	insert a new node and return its id More...
std::vector< NodeId >	addNodes (Size n)
	insert n nodes More...
virtual void	addNodeWithId (const NodeId id)
	try to insert a node with the given id More...
virtual void	eraseNode (const NodeId id)
	erase the node with the given id More...
bool	existsNode (const NodeId id) const
	returns true iff the NodeGraphPart contains the given nodeId More...
bool	exists (const NodeId id) const
	alias for existsNode More...
bool	emptyNodes () const
	indicates whether there exists nodes in the NodeGraphPart More...
bool	empty () const
	alias for emptyNodes More...
virtual void	clearNodes ()
	remove all the nodes from the NodeGraphPart More...
virtual void	clear ()
	alias for clearNodes More...
Size	sizeNodes () const
	returns the number of nodes in the NodeGraphPart More...
Size	size () const
	alias for sizeNodes More...
NodeId	bound () const
	returns a number n such that all node ids are strictly lower than n More...
NodeSet	asNodeSet () const
	returns a copy of the set of nodes represented by the NodeGraphPart More...
const NodeGraphPart &	nodes () const
	return *this as a NodeGraphPart More...
node_iterator_safe	beginSafe () const
	a begin iterator to parse the set of nodes contained in the NodeGraphPart More...
const node_iterator_safe &	endSafe () const noexcept
	the end iterator to parse the set of nodes contained in the NodeGraphPart More...
node_iterator	begin () const noexcept
	a begin iterator to parse the set of nodes contained in the NodeGraphPart More...
const node_iterator &	end () const noexcept
	the end iterator to parse the set of nodes contained in the NodeGraphPart More...
std::string	toString () const
	a function to display the set of nodes More...
template<typename VAL >
NodeProperty< VAL >	nodesProperty (VAL(*f)(const NodeId &), Size size=0) const
	a method to create a HashTable with key:NodeId and value:VAL More...
template<typename VAL >
NodeProperty< VAL >	nodesProperty (const VAL &a, Size size=0) const
	a method to create a hashMap with key:NodeId and value:VAL More...
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)) More...

Public Types
typedef NodeGraphPartIterator	NodeIterator
typedef NodeGraphPartIterator	NodeConstIterator
typedef NodeGraphPartIteratorSafe	NodeIteratorSafe
typedef NodeGraphPartIteratorSafe	NodeConstIteratorSafe
using	node_iterator = NodeGraphPartIterator
	types for STL compliance More...
using	node_const_iterator = NodeGraphPartIterator
	types for STL compliance More...
using	node_iterator_safe = NodeGraphPartIteratorSafe
	types for STL compliance More...
using	node_const_iterator_safe = NodeGraphPartIteratorSafe
	types for STL compliance More...

Friends
class	NodeGraphPartIterator
class	NodeGraphPartIteratorSafe
class	gum_tests::NodeGraphPartTestSuite
	to enable testunits to use __check More...

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 and Christophe GONZALES

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 253 of file nodeGraphPart.h.

Member Typedef Documentation

node_const_iterator

using gum::NodeGraphPart::node_const_iterator = NodeGraphPartIterator

types for STL compliance

Definition at line 258 of file nodeGraphPart.h.

node_const_iterator_safe

using gum::NodeGraphPart::node_const_iterator_safe = NodeGraphPartIteratorSafe

types for STL compliance

Definition at line 260 of file nodeGraphPart.h.

node_iterator

using gum::NodeGraphPart::node_iterator = NodeGraphPartIterator

types for STL compliance

Definition at line 257 of file nodeGraphPart.h.

node_iterator_safe

using gum::NodeGraphPart::node_iterator_safe = NodeGraphPartIteratorSafe

types for STL compliance

Definition at line 259 of file nodeGraphPart.h.

NodeConstIterator

typedef NodeGraphPartIterator gum::NodeGraphPart::NodeConstIterator

Definition at line 267 of file nodeGraphPart.h.

NodeConstIteratorSafe

typedef NodeGraphPartIteratorSafe gum::NodeGraphPart::NodeConstIteratorSafe

Definition at line 269 of file nodeGraphPart.h.

NodeIterator

typedef NodeGraphPartIterator gum::NodeGraphPart::NodeIterator

Definition at line 266 of file nodeGraphPart.h.

NodeIteratorSafe

typedef NodeGraphPartIteratorSafe gum::NodeGraphPart::NodeIteratorSafe

Definition at line 268 of file nodeGraphPart.h.

Constructor & Destructor Documentation

NodeGraphPart() [1/2]

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 35 of file nodeGraphPart.cpp.

References __holes, and __updateEndIteratorSafe().

                                                                        :
      __holes_size(holes_size), __holes_resize_policy(holes_resize_policy),
      __endIteratorSafe(*this), __boundVal(0) {
    __holes = nullptr;
    GUM_CONSTRUCTOR(NodeGraphPart);
    __updateEndIteratorSafe();
  }

Here is the call graph for this function:

NodeGraphPart() [2/2]

gum::NodeGraphPart::NodeGraphPart

(

const NodeGraphPart &

s

)

copy constructor

Parameters

s	the NodeGraphPart to be copied

Definition at line 43 of file nodeGraphPart.cpp.

References __holes, and __updateEndIteratorSafe().

                                                     :
      __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);

    __updateEndIteratorSafe();

    GUM_CONS_CPY(NodeGraphPart);
  }

Here is the call graph for this function:

~NodeGraphPart()

gum::NodeGraphPart::~NodeGraphPart ( )

virtual

destructor

Definition at line 55 of file nodeGraphPart.cpp.

References __holes.

                                {
    if (__holes) delete __holes;

    GUM_DESTRUCTOR(NodeGraphPart);
  }

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 74 of file nodeGraphPart.cpp.

References __boundVal, __holes, __holes_resize_policy, __holes_size, __updateEndIteratorSafe(), gum::Set< Key, Alloc >::contains(), gum::Set< Key, Alloc >::empty(), gum::Set< Key, Alloc >::erase(), and gum::Set< Key, Alloc >::insert().

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

Here is the call graph for this function:

__clearNodes()

void gum::NodeGraphPart::__clearNodes ( )

private

code for clearing nodes (called twice)

Definition at line 152 of file nodeGraphPart.cpp.

References __boundVal, __holes, __inHoles(), __updateEndIteratorSafe(), bound(), GUM_EMIT1, and onNodeDeleted.

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

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

Referenced by addNodeWithId().

                                                  {
    __holes->erase(id);

    if (__holes->empty()) {
      delete __holes;
      __holes = nullptr;
    }
  }

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 374 of file nodeGraphPart_inl.h.

Referenced by __clearNodes(), gum::NodeGraphPartIterator::_validate(), addNodeWithId(), and toString().

                                                      {
    return __holes && __holes->contains(id);
  }

Here is the caller graph for this function:

__sizeHoles()

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

private

Returns

the size of __holes

Definition at line 379 of file nodeGraphPart_inl.h.

                                               {
    return __holes ? __holes->size() : (Size)0;
  }

__updateEndIteratorSafe()

INLINE void gum::NodeGraphPart::__updateEndIteratorSafe ( )

private

updating endIterator (always at __max+1)

Definition at line 322 of file nodeGraphPart_inl.h.

Referenced by __addHole(), __clearNodes(), addNodeWithId(), NodeGraphPart(), and populateNodes().

                                                     {
    __endIteratorSafe._setPos(__boundVal);
  }

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 250 of file nodeGraphPart_inl.h.

References GUM_EMIT1.

Referenced by gum::prm::gspan::DFSTree< GUM_SCALAR >::__addChild(), gum::prm::StructuredInference< GUM_SCALAR >::__addEdgesInReducedGraph(), gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__addInterface2Dag(), gum::prm::ClassDependencyGraph< GUM_SCALAR >::__addNode(), gum::prm::o3prm::O3TypeFactory< GUM_SCALAR >::__addTypes2Dag(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::__buildPatternGraph(), gum::prm::StructuredInference< GUM_SCALAR >::__buildPatternGraph(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::__checkAndAddNodesToDag(), gum::prm::LayerGenerator< GUM_SCALAR >::__generateClassDag(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::__generateClassDag(), gum::prm::gspan::DFSTree< GUM_SCALAR >::__initialiaze_root(), gum::IncrementalGraphLearner< AttributeSelection, isScalar >::_insertNode(), gum::prm::gspan::DFSTree< GUM_SCALAR >::addRoot(), gum::prm::gspan::DFSTree< GUM_SCALAR >::growPattern(), gum::IncrementalGraphLearner< AttributeSelection, isScalar >::IncrementalGraphLearner(), gum::prm::gspan::EdgeGrowth< GUM_SCALAR >::insert(), and gum::LeafAggregator::update().

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

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 268 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;
  }

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

Definition at line 129 of file nodeGraphPart.cpp.

References __boundVal, __eraseHole(), __holes, __holes_resize_policy, __holes_size, __inHoles(), __updateEndIteratorSafe(), GUM_EMIT1, GUM_ERROR, gum::Set< Key, Alloc >::insert(), and onNodeAdded.

Referenced by gum::EssentialGraph::__buildEssentialGraph(), gum::MarkovBlanket::__buildMarkovBlanket(), gum::SpanningForestPrim::__computeInAComponent(), gum::learning::genericBNLearner::__learnDAG(), gum::learning::genericBNLearner::__prepare_miic_3off2(), gum::prm::GSpan< GUM_SCALAR >::__sortPatterns(), gum::InfluenceDiagram< GUM_SCALAR >::_addNode(), gum::InfluenceDiagram< GUM_SCALAR >::_moralGraph(), gum::prm::gspan::Pattern::addNodeWithLabel(), gum::prm::StructuredInference< GUM_SCALAR >::CData::CData(), gum::InfluenceDiagram< GUM_SCALAR >::getDecisionGraph(), gum::BayesNetFragment< GUM_SCALAR >::installNode(), gum::prm::gspan::InterfaceGraph< GUM_SCALAR >::InterfaceGraph(), gum::learning::Miic::learnStructure(), gum::UndiGraph::partialUndiGraph(), and gum::learning::StructuralConstraintDAG::StructuralConstraintDAG().

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

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 358 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::insert().

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::getPartialTemporalOrder().

                                                {
    NodeSet son(sizeNodes());

    if (!empty()) {
      for (NodeId n = 0; n < __boundVal; ++n) {
        if (!__inHoles(n)) son.insert(n);
      }
    }

    return son;
  }

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 330 of file nodeGraphPart_inl.h.

References gum::NodeGraphPartIterator::_validate().

Referenced by gum::prm::gspan::DFSTree< GUM_SCALAR >::parent().

                                                                   {
    NodeGraphPartIterator it(*this);
    it._validate();   // stop the iterator at the first not-in-holes
    return it;
  }

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 316 of file nodeGraphPart_inl.h.

References gum::NodeGraphPartIterator::_validate().

                                                                  {
    NodeGraphPartIteratorSafe it(*this);
    it._validate();   // stop the iterator at the first not-in-holes
    return it;
  }

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

Referenced by __clearNodes(), gum::StaticTriangulation::__computeEliminationTree(), gum::NodeGraphPartIterator::_setPos(), and gum::NodeGraphPartIterator::_validate().

{ return __boundVal; }

Here is the caller graph for this function:

clear()

INLINE void gum::NodeGraphPart::clear ( )

virtual

alias for clearNodes

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

Definition at line 314 of file nodeGraphPart_inl.h.

Referenced by populateNodes().

{ __clearNodes(); }

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 307 of file nodeGraphPart_inl.h.

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

{ __clearNodes(); }

Here is the caller graph for this function:

empty()

INLINE bool gum::NodeGraphPart::empty

(

)

const

alias for emptyNodes

Definition at line 303 of file nodeGraphPart_inl.h.

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

{ return emptyNodes(); }

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 301 of file nodeGraphPart_inl.h.

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

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 336 of file nodeGraphPart_inl.h.

                                                                        {
    return __endIteratorSafe;
  }

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 326 of file nodeGraphPart_inl.h.

                                                                                {
    return __endIteratorSafe;
  }

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::MixedGraph, gum::DiGraph, gum::UndiGraph, and gum::CliqueGraph.

Definition at line 293 of file nodeGraphPart_inl.h.

References GUM_EMIT1.

Referenced by gum::LeafAggregator::__removeContext(), gum::IncrementalGraphLearner< AttributeSelection, isScalar >::_removeNode(), gum::UndiGraph::eraseNode(), gum::DiGraph::eraseNode(), and gum::MixedGraph::eraseNode().

                                                        {
    if (!existsNode(node)) return;

    __addHole(node);

    GUM_EMIT1(onNodeDeleted, node);
  }

Here is the caller graph for this function:

exists()

INLINE bool gum::NodeGraphPart::exists

(

const NodeId

id

)

const

alias for existsNode

Definition at line 289 of file nodeGraphPart_inl.h.

Referenced by gum::MarkovBlanket::__buildMarkovBlanket(), gum::prm::ClassBayesNet< GUM_SCALAR >::__get(), gum::DAG::__hasDirectedPath(), gum::learning::genericBNLearner::__learnDAG(), gum::prm::StructuredInference< GUM_SCALAR >::__removeNode(), gum::NodeGraphPartIterator::_setPos(), gum::prm::gspan::Pattern::addArc(), gum::DiGraph::addArc(), gum::UndiGraph::addEdge(), and gum::prm::gspan::Pattern::exists().

                                                           {
    return existsNode(node);
  }

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 283 of file nodeGraphPart_inl.h.

Referenced by gum::MarkovBlanket::__buildMarkovBlanket(), gum::SpanningForestPrim::__compute(), gum::SpanningForestPrim::__computeInAComponent(), gum::SpanningForestPrim::__exploreNode(), gum::OrderedEliminationSequenceStrategy::__isOrderNeeded(), gum::PartialOrderedEliminationSequenceStrategy::_isPartialOrderNeeded(), gum::OrderedEliminationSequenceStrategy::eliminationUpdate(), gum::DefaultPartialOrderedEliminationSequenceStrategy::eliminationUpdate(), gum::InfluenceDiagram< GUM_SCALAR >::getDecisionGraph(), gum::BayesNetFragment< GUM_SCALAR >::isInstalledNode(), gum::UndiGraph::partialUndiGraph(), gum::OrderedEliminationSequenceStrategy::setOrder(), and gum::PartialOrderedEliminationSequenceStrategy::setPartialOrder().

                                                               {
    if (node >= __boundVal) return false;

    return (!__inHoles(node));
  }

Here is the caller graph for this function:

listMapNodes()

template<typename VAL >

List< VAL > gum::NodeGraphPart::listMapNodes

(

VAL(*)(const NodeId &)

f

)

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

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 223 of file nodeGraphPart_inl.h.

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::_addNode().

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

Here is the caller graph for this function:

nodes()

INLINE const NodeGraphPart & gum::NodeGraphPart::nodes

(

)

const

return *this as a NodeGraphPart

Definition at line 370 of file nodeGraphPart_inl.h.

Referenced by gum::MarkovBlanket::__buildMarkovBlanket(), gum::SpanningForestPrim::__compute(), gum::StaticTriangulation::__computeMaxPrimeJunctionTree(), gum::prm::LayerGenerator< GUM_SCALAR >::__generateClassDag(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::__generateClassDag(), gum::prm::GSpan< GUM_SCALAR >::__sortPatterns(), gum::credal::CNMonteCarloSampling< GUM_SCALAR, BNInferenceEngine >::__threadUpdate(), gum::InfluenceDiagram< GUM_SCALAR >::_moralGraph(), gum::InfluenceDiagram< GUM_SCALAR >::_removeTables(), gum::prm::StructuredInference< GUM_SCALAR >::CData::CData(), gum::StaticTriangulation::fillIns(), gum::InfluenceDiagram< GUM_SCALAR >::getDecisionGraph(), gum::prm::gspan::DFSTree< GUM_SCALAR >::growPattern(), gum::UndiGraph::hasUndirectedCycle(), gum::DAG::moralGraph(), gum::MarkovBlanket::nodes(), gum::EssentialGraph::nodes(), gum::prm::gspan::Pattern::nodes(), gum::MarkovBlanket::toDot(), gum::EssentialGraph::toDot(), gum::InfluenceDiagram< GUM_SCALAR >::toDot(), gum::UndiGraph::toDot(), gum::DiGraph::toDot(), and gum::MixedGraph::toDot().

                                                         {
    return *(static_cast< const NodeGraphPart* >(this));
  }

Here is the caller graph for this function:

nodesProperty() [1/2]

template<typename VAL >

NodeProperty< VAL > gum::NodeGraphPart::nodesProperty	(	VAL(*)(const NodeId &)	f,
		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.

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::_getChildrenDecision(), gum::BarrenNodesFinder::barrenNodes(), gum::BinaryJoinTreeConverterDefault::convert(), gum::InfluenceDiagram< GUM_SCALAR >::existsPathBetween(), and gum::UndiGraph::hasUndirectedCycle().

Here is the caller graph for this function:

nodesProperty() [2/2]

template<typename VAL >

NodeProperty< VAL > gum::NodeGraphPart::nodesProperty	(	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.

operator!=()

INLINE bool gum::NodeGraphPart::operator!=

(

const NodeGraphPart &

p

)

const

check whether two NodeGraphParts contain different nodes

Parameters

p	the NodeGraphPart to be compared with "this"

Definition at line 354 of file nodeGraphPart_inl.h.

References gum::NodeGraphPartIterator::operator==().

                                                                    {
    return !operator==(p);
  }

Here is the call graph for this function:

operator=()

INLINE NodeGraphPart & gum::NodeGraphPart::operator=

(

const NodeGraphPart &

p

)

copy operator

Parameters

p	the NodeGraphPart to be copied

Definition at line 216 of file nodeGraphPart_inl.h.

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

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

    return *this;
  }

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

References __boundVal, and __holes.

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

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

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 61 of file nodeGraphPart.cpp.

References __boundVal, __holes, __holes_resize_policy, __holes_size, __updateEndIteratorSafe(), and clear().

Referenced by gum::DAGmodel::__moralGraph(), and gum::DAG::moralGraph().

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

    __boundVal = s.__boundVal;

    __updateEndIteratorSafe();
  }

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.

size()

INLINE Size gum::NodeGraphPart::size

(

)

const

alias for sizeNodes

Definition at line 281 of file nodeGraphPart_inl.h.

Referenced by gum::StaticTriangulation::__computeMaxPrimeJunctionTree(), gum::StaticTriangulation::__computeRecursiveThinning(), gum::OrderedEliminationSequenceStrategy::__isOrderNeeded(), gum::DiGraph::__topologicalOrder(), gum::StaticTriangulation::__triangulate(), gum::PartialOrderedEliminationSequenceStrategy::_isPartialOrderNeeded(), gum::BarrenNodesFinder::barrenNodes(), gum::prm::gspan::DFSTree< GUM_SCALAR >::growPattern(), gum::learning::GreedyHillClimbing::learnStructure(), gum::learning::LocalSearchWithTabuList::learnStructure(), gum::BayesBall::relevantPotentials(), gum::dSeparation::relevantPotentials(), gum::BayesBall::requisiteNodes(), gum::dSeparation::requisiteNodes(), gum::StaticTriangulation::setGraph(), gum::MarkovBlanket::size(), gum::EssentialGraph::size(), gum::DAGmodel::size(), gum::prm::gspan::Pattern::size(), gum::StaticTriangulation::StaticTriangulation(), and gum::UndiGraph::toDot().

{ return sizeNodes(); }

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 277 of file nodeGraphPart_inl.h.

Referenced by gum::BinaryJoinTreeConverterDefault::__markConnectedComponent(), gum::BarrenNodesFinder::barrenNodes(), gum::BinaryJoinTreeConverterDefault::convert(), gum::EliminationSequenceStrategy::setGraph(), gum::MarkovBlanket::sizeNodes(), and gum::EssentialGraph::sizeNodes().

                                             {
    return (__holes) ? (__boundVal - __holes->size()) : __boundVal;
  }

Here is the caller graph for this function:

toString()

std::string gum::NodeGraphPart::toString

(

)

const

a function to display the set of nodes

Definition at line 102 of file nodeGraphPart.cpp.

References __boundVal, and __inHoles().

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

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

    for (NodeId id = 0; id < __boundVal; ++id) {
      if (__inHoles(id)) continue;

      if (first) {
        first = false;
      } else {
        s << ",";
      }

      s << id;
    }

    s << "}";

    return s.str();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

gum_tests::NodeGraphPartTestSuite

friend class gum_tests::NodeGraphPartTestSuite

friend

to enable testunits to use __check

Definition at line 467 of file nodeGraphPart.h.

NodeGraphPartIterator

friend class NodeGraphPartIterator

friend

Definition at line 462 of file nodeGraphPart.h.

NodeGraphPartIteratorSafe

friend class NodeGraphPartIteratorSafe

friend

Definition at line 463 of file nodeGraphPart.h.

Member Data Documentation

__boundVal

NodeId gum::NodeGraphPart::__boundVal

private

the id below which NodeIds may belong to the NodeGraphPart

Definition at line 511 of file nodeGraphPart.h.

Referenced by __addHole(), __clearNodes(), addNodeWithId(), operator==(), populateNodes(), and toString().

__endIteratorSafe

NodeGraphPartIteratorSafe gum::NodeGraphPart::__endIteratorSafe

private

the end iterator (used to speed-up parsings of the NodeGraphPart)

Definition at line 508 of file nodeGraphPart.h.

__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 499 of file nodeGraphPart.h.

Referenced by __addHole(), __clearNodes(), addNodeWithId(), NodeGraphPart(), operator==(), populateNodes(), and ~NodeGraphPart().

__holes_resize_policy

bool gum::NodeGraphPart::__holes_resize_policy

private

value for __holes configuration

Definition at line 505 of file nodeGraphPart.h.

Referenced by __addHole(), addNodeWithId(), and populateNodes().

__holes_size

Size gum::NodeGraphPart::__holes_size

private

value for __holes configuration

Definition at line 502 of file nodeGraphPart.h.

Referenced by __addHole(), addNodeWithId(), and populateNodes().

onNodeAdded

Signaler1< NodeId > gum::NodeGraphPart::onNodeAdded

Definition at line 271 of file nodeGraphPart.h.

Referenced by addNodeWithId().

onNodeDeleted

Signaler1< NodeId > gum::NodeGraphPart::onNodeDeleted

Definition at line 272 of file nodeGraphPart.h.

Referenced by __clearNodes().

---

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

• agrum/graphs/parts/nodeGraphPart.h
• agrum/graphs/parts/nodeGraphPart.cpp
• agrum/graphs/parts/nodeGraphPart_inl.h