aGrUM  0.13.2
gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT > Class Template Reference

The basic class for computing the next graph changes possible in an undirected structure learning algorithm. More...

#include <graphChangesGenerator4UndiGraph.h>

+ Inheritance diagram for gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >:
+ Collaboration diagram for gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >:

Public Member Functions

Constructors / Destructors
 GraphChangesGenerator4UndiGraph (STRUCT_CONSTRAINT &constraint)
 default constructor More...
 
 GraphChangesGenerator4UndiGraph (const GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT > &from)
 copy constructor More...
 
 GraphChangesGenerator4UndiGraph (GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT > &&from)
 move operator More...
 
virtual ~GraphChangesGenerator4UndiGraph ()
 destructor More...
 
Operators
GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT > & operator= (const GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT > &from)
 copy operator More...
 
GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT > & operator= (GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT > &&from)
 move operator More...
 
Iterators
iterator begin () const
 returns an (unsafe) iterator on the beginning of the list of operators More...
 
const iteratorend () const
 returns an (unsafe) iterator on the end of the list of operators More...
 
Accessors / Modifiers
STRUCT_CONSTRAINT & constraint () const noexcept
 returns the constraint that is used by the generator More...
 
void setGraph (const UndiGraph &graph)
 sets a new graph from which the operator will compute possible changes More...
 
void modifyGraph (const EdgeAddition &change)
 notify the operator set of a change applied to the graph More...
 
void modifyGraph (const EdgeDeletion &change)
 notify the operator set of a change applied to the graph More...
 
void modifyGraph (const GraphChange &change)
 notify the operator set of a change applied to the graph More...
 
void clearChanges () noexcept
 empty the set of possible change operators that can be applied More...
 
void notifyGetCompleted ()
 notifies the generator that we have parsed all its legal changes More...
 
void setMaxNbThreads (Size nb) noexcept
 sets the maximum number of threads used to compute the set of changes More...
 

Public Types

using iterator = typename Set< GraphChange >::const_iterator
 the iterator for parsing the list of possible graph change operators More...
 
using const_iterator = iterator
 the const iterator for parsing the list of graph change operators More...
 

Protected Attributes

UndiGraph _graph
 the graph on which we generate operators More...
 
STRUCT_CONSTRAINT * _constraint
 a reference on the structural constraint used to restrict the changes More...
 
Set< GraphChange_legal_changes
 the current set of operators More...
 

Protected Member Functions

void _createChanges ()
 create the set of legal and illegal changes from a given graph More...
 

Detailed Description

template<typename STRUCT_CONSTRAINT>
class gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >

The basic class for computing the next graph changes possible in an undirected structure learning algorithm.

Structure learning algorithm try different modifications of the graph. Class GraphChangesGenerator4UndiGraph provides a simple way to compute those that we wish to perform. For instance, in the basic PC algorithm for learning undirected graphs, one may expect that all possible edge additions and deletions can be applied and GraphChangesGenerator4UndiGraph provides exactly this set of operations. This class provides the following minimal methods:

  • void setGraph ( const UndiGraph& ) : assigns a new graph as a starting point to the generator of graph change operators
  • void modifyGraph ( const GraphChange& ) : indicate to the operator set that the graph has been changed and that we need to compute the new operators that result from this change
  • void clearChanges () : empty the set of possible operators
  • methods begin () and end () that return iterators allowing to parse the available set of operators.

Basically, the idea is to use method setGraph at the beginning of the structure learning in order to initialize the possible set of operators. Then, parse this set using a for ( auto iter = operator_set.begin (); iter != operator_set.end (); ++iter ) loop and compute the scores induced by these changes. When this is done, flush the operator set by calling method clearChanges. Then iterate changes and after each new change applied, used again the iterator for loop, and so on. Note that, whenever you execute method modifyGraph, this will automatically flush the current list of changes and put into the list only the changes that are affected by the graph modification.

Definition at line 108 of file graphChangesGenerator4UndiGraph.h.

Member Typedef Documentation

template<typename STRUCT_CONSTRAINT>
using gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::const_iterator = iterator

the const iterator for parsing the list of graph change operators

Definition at line 115 of file graphChangesGenerator4UndiGraph.h.

template<typename STRUCT_CONSTRAINT>
using gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::iterator = typename Set< GraphChange >::const_iterator

the iterator for parsing the list of possible graph change operators

Definition at line 112 of file graphChangesGenerator4UndiGraph.h.

Constructor & Destructor Documentation

template<typename STRUCT_CONSTRAINT>
gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::GraphChangesGenerator4UndiGraph ( STRUCT_CONSTRAINT &  constraint)

default constructor

template<typename STRUCT_CONSTRAINT>
gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::GraphChangesGenerator4UndiGraph ( const GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT > &  from)

copy constructor

template<typename STRUCT_CONSTRAINT>
gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::GraphChangesGenerator4UndiGraph ( GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT > &&  from)

move operator

template<typename STRUCT_CONSTRAINT>
virtual gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::~GraphChangesGenerator4UndiGraph ( )
virtual

destructor

Member Function Documentation

template<typename STRUCT_CONSTRAINT>
void gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::_createChanges ( )
protected

create the set of legal and illegal changes from a given graph

template<typename STRUCT_CONSTRAINT>
iterator gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::begin ( ) const
virtual

returns an (unsafe) iterator on the beginning of the list of operators

Implements gum::learning::IGraphChangesGenerator4UndiGraph.

template<typename STRUCT_CONSTRAINT>
void gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::clearChanges ( )
virtualnoexcept

empty the set of possible change operators that can be applied

Implements gum::learning::IGraphChangesGenerator4UndiGraph.

template<typename STRUCT_CONSTRAINT>
STRUCT_CONSTRAINT& gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::constraint ( ) const
noexcept

returns the constraint that is used by the generator

template<typename STRUCT_CONSTRAINT>
const iterator& gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::end ( ) const
virtual

returns an (unsafe) iterator on the end of the list of operators

Implements gum::learning::IGraphChangesGenerator4UndiGraph.

template<typename STRUCT_CONSTRAINT>
void gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::modifyGraph ( const EdgeAddition change)
virtual

notify the operator set of a change applied to the graph

Implements gum::learning::IGraphChangesGenerator4UndiGraph.

template<typename STRUCT_CONSTRAINT>
void gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::modifyGraph ( const EdgeDeletion change)
virtual

notify the operator set of a change applied to the graph

Implements gum::learning::IGraphChangesGenerator4UndiGraph.

template<typename STRUCT_CONSTRAINT>
void gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::modifyGraph ( const GraphChange change)
virtual

notify the operator set of a change applied to the graph

Implements gum::learning::IGraphChangesGenerator4UndiGraph.

template<typename STRUCT_CONSTRAINT>
void gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::notifyGetCompleted ( )
virtual

notifies the generator that we have parsed all its legal changes

Implements gum::learning::IGraphChangesGenerator4UndiGraph.

template<typename STRUCT_CONSTRAINT>
GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >& gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::operator= ( const GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT > &  from)

copy operator

template<typename STRUCT_CONSTRAINT>
GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >& gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::operator= ( GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT > &&  from)

move operator

template<typename STRUCT_CONSTRAINT>
void gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::setGraph ( const UndiGraph graph)
virtual

sets a new graph from which the operator will compute possible changes

Implements gum::learning::IGraphChangesGenerator4UndiGraph.

template<typename STRUCT_CONSTRAINT>
void gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::setMaxNbThreads ( Size  nb)
noexcept

sets the maximum number of threads used to compute the set of changes

Member Data Documentation

template<typename STRUCT_CONSTRAINT>
Size gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::__max_threads_number {1}
private

the max number of threads authorized

Definition at line 215 of file graphChangesGenerator4UndiGraph.h.

template<typename STRUCT_CONSTRAINT>
STRUCT_CONSTRAINT* gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::_constraint
protected

a reference on the structural constraint used to restrict the changes

Definition at line 202 of file graphChangesGenerator4UndiGraph.h.

template<typename STRUCT_CONSTRAINT>
UndiGraph gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::_graph
protected

the graph on which we generate operators

Definition at line 199 of file graphChangesGenerator4UndiGraph.h.

template<typename STRUCT_CONSTRAINT>
Set< GraphChange > gum::learning::GraphChangesGenerator4UndiGraph< STRUCT_CONSTRAINT >::_legal_changes
protected

the current set of operators

Definition at line 205 of file graphChangesGenerator4UndiGraph.h.


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