aGrUM  0.13.2
gum::learning::StructuralConstraintDiGraph Class Reference

The base class for structural constraints used by learning algorithms that learn a directed graph structure. More...

#include <structuralConstraintDiGraph.h>

+ Inheritance diagram for gum::learning::StructuralConstraintDiGraph:
+ Collaboration diagram for gum::learning::StructuralConstraintDiGraph:

Public Member Functions

Constructors / Destructors
 StructuralConstraintDiGraph ()
 default constructor More...
 
 StructuralConstraintDiGraph (Size nb_nodes)
 constructor starting with an empty graph with a given number of nodes More...
 
 StructuralConstraintDiGraph (const DiGraph &graph)
 constructor starting with a given graph More...
 
 StructuralConstraintDiGraph (const StructuralConstraintDiGraph &from)
 copy constructor More...
 
 StructuralConstraintDiGraph (StructuralConstraintDiGraph &&from)
 move constructor More...
 
virtual ~StructuralConstraintDiGraph ()
 destructor More...
 
Operators
StructuralConstraintDiGraphoperator= (const StructuralConstraintDiGraph &from)
 copy operator More...
 
StructuralConstraintDiGraphoperator= (StructuralConstraintDiGraph &&from)
 move operator More...
 
Specific Accessors / Modifiers
void setGraph (Size nb_nodes)
 sets a new empty graph from which we will perform checkings More...
 
void setGraphAlone (const DiGraph &graph)
 sets a new graph from which we will perform checkings More...
 
void modifyGraphAlone (const ArcAddition &change)
 notify the constraint of a modification of the graph More...
 
void modifyGraphAlone (const ArcDeletion &change)
 notify the constraint of a modification of the graph More...
 
void modifyGraphAlone (const ArcReversal &change)
 notify the constraint of a modification of the graph More...
 
void modifyGraphAlone (const GraphChange &change)
 notify the constraint of a modification of the graph More...
 
bool isAlwaysInvalidAlone (const GraphChange &change) const
 indicates whether a change will always violate the constraint More...
 
bool checkArcAdditionAlone (NodeId x, NodeId y) const
 checks whether the constraints enable to add arc (x,y) More...
 
bool checkArcDeletionAlone (NodeId x, NodeId y) const
 checks whether the constraints enable to remove arc (x,y) More...
 
bool checkArcReversalAlone (NodeId x, NodeId y) const
 checks whether the constraints enable to reverse arc (x,y) More...
 
bool checkModificationAlone (const GraphChange &change) const
 checks whether the constraints enable to perform a graph change More...
 
bool checkModificationAlone (const ArcAddition &change) const
 checks whether the constraints enable to add an arc More...
 
bool checkModificationAlone (const ArcDeletion &change) const
 checks whether the constraints enable to remove an arc More...
 
bool checkModificationAlone (const ArcReversal &change) const
 checks whether the constraints enable to reverse an arc More...
 

Public Types

using allConstraints = __ConstraintSet< void >
 

Protected Attributes

DiGraph _DiGraph__graph
 the DiGraph on which we perform checks More...
 

Detailed Description

The base class for structural constraints used by learning algorithms that learn a directed graph structure.

This base should always be a virtual parents of the structural constraints classes. This will allow to combine different constraints into a single class

Definition at line 48 of file structuralConstraintDiGraph.h.

Member Typedef Documentation

using gum::learning::StructuralConstraintEmpty::allConstraints = __ConstraintSet< void >
inherited

Definition at line 39 of file structuralConstraint.h.

Constructor & Destructor Documentation

gum::learning::StructuralConstraintDiGraph::StructuralConstraintDiGraph ( )

default constructor

Definition at line 39 of file structuralConstraintDiGraph.cpp.

39  {
40  GUM_CONSTRUCTOR(StructuralConstraintDiGraph);
41  }
gum::learning::StructuralConstraintDiGraph::StructuralConstraintDiGraph ( Size  nb_nodes)

constructor starting with an empty graph with a given number of nodes

Definition at line 44 of file structuralConstraintDiGraph.cpp.

References setGraph().

44  {
45  setGraph(nb_nodes);
46  GUM_CONSTRUCTOR(StructuralConstraintDiGraph);
47  }
void setGraph(Size nb_nodes)
sets a new empty graph from which we will perform checkings

+ Here is the call graph for this function:

gum::learning::StructuralConstraintDiGraph::StructuralConstraintDiGraph ( const DiGraph graph)

constructor starting with a given graph

Definition at line 50 of file structuralConstraintDiGraph.cpp.

References setGraph().

51  {
52  setGraph(graph);
53  GUM_CONSTRUCTOR(StructuralConstraintDiGraph);
54  }
void setGraph(Size nb_nodes)
sets a new empty graph from which we will perform checkings

+ Here is the call graph for this function:

gum::learning::StructuralConstraintDiGraph::StructuralConstraintDiGraph ( const StructuralConstraintDiGraph from)

copy constructor

Definition at line 57 of file structuralConstraintDiGraph.cpp.

58  :
59  _DiGraph__graph(from._DiGraph__graph) {
60  GUM_CONS_CPY(StructuralConstraintDiGraph);
61  }
DiGraph _DiGraph__graph
the DiGraph on which we perform checks
gum::learning::StructuralConstraintDiGraph::StructuralConstraintDiGraph ( StructuralConstraintDiGraph &&  from)

move constructor

Definition at line 64 of file structuralConstraintDiGraph.cpp.

65  :
66  _DiGraph__graph(std::move(from._DiGraph__graph)) {
67  GUM_CONS_MOV(StructuralConstraintDiGraph);
68  }
DiGraph _DiGraph__graph
the DiGraph on which we perform checks
gum::learning::StructuralConstraintDiGraph::~StructuralConstraintDiGraph ( )
virtual

destructor

Definition at line 71 of file structuralConstraintDiGraph.cpp.

References operator=().

71  {
72  GUM_DESTRUCTOR(StructuralConstraintDiGraph);
73  }

+ Here is the call graph for this function:

Member Function Documentation

bool gum::learning::StructuralConstraintDiGraph::checkArcAdditionAlone ( NodeId  x,
NodeId  y 
) const

checks whether the constraints enable to add arc (x,y)

an arc can be added if and only if its extremal nodes belong to the graph and the arc does not already exist.

bool gum::learning::StructuralConstraintDiGraph::checkArcDeletionAlone ( NodeId  x,
NodeId  y 
) const

checks whether the constraints enable to remove arc (x,y)

an arc can be removed if and only if the arc exists.

bool gum::learning::StructuralConstraintDiGraph::checkArcReversalAlone ( NodeId  x,
NodeId  y 
) const

checks whether the constraints enable to reverse arc (x,y)

an arc can be reversed if and only if it exists and arc (y,x) does not.

bool gum::learning::StructuralConstraintDiGraph::checkModificationAlone ( const GraphChange change) const

checks whether the constraints enable to perform a graph change

An arc can be added if and only if its extremal nodes belong to the graph and the arc does not already exist. An arc can be removed if and only if the arc exists. An arc (x,y) can be reversed if and only if it exists and arc (y,x) does not.

bool gum::learning::StructuralConstraintDiGraph::checkModificationAlone ( const ArcAddition change) const

checks whether the constraints enable to add an arc

an arc can be added if and only if its extremal nodes belong to the graph and the arc does not already exist.

bool gum::learning::StructuralConstraintDiGraph::checkModificationAlone ( const ArcDeletion change) const

checks whether the constraints enable to remove an arc

an arc can be removed if and only if the arc exists.

bool gum::learning::StructuralConstraintDiGraph::checkModificationAlone ( const ArcReversal change) const

checks whether the constraints enable to reverse an arc

an arc (x,y) can be reversed if and only if it exists and arc (y,x) does not.

bool gum::learning::StructuralConstraintDiGraph::isAlwaysInvalidAlone ( const GraphChange change) const

indicates whether a change will always violate the constraint

Some learning algorithms need examine several times whether a given graph change can be applied. For instance, the first time arc (X,Y) addition is considered, the learning algorithm may discard this change because it violates the structural constraint (e.g., if the latter enforces a DAG structure, this arc addition might induce a directed cycle), but, later on, other arc removal may induce that the arc addition is now possible. Such change is thus not always invalid. Conversely, there are changes that can be discarded once and for all. For instance, in a 2TBN structure, it is always impossible to add a backward-time arc. Such graph changes are always invalid and are therefore tagged as such by the isAlwaysInvalid method.

void gum::learning::StructuralConstraintDiGraph::modifyGraphAlone ( const ArcAddition change)

notify the constraint of a modification of the graph

Warning
If an already existing arc is added nothing is done. In particular, no exception is raised.
Exceptions
InvalidNodeexception is thrown if an arc (x,y) is added and x or y does not belong to the graph nodes
void gum::learning::StructuralConstraintDiGraph::modifyGraphAlone ( const ArcDeletion change)

notify the constraint of a modification of the graph

Warning
If a nonexisting arc is removed, nothing is done. In particular, no exception is raised.
void gum::learning::StructuralConstraintDiGraph::modifyGraphAlone ( const ArcReversal change)

notify the constraint of a modification of the graph

Warning
If an already existing arc is added, or if a nonexisting arc is removed, nothing is done. In particular, no exception is raised.
Exceptions
InvalidNodeexception is thrown if at least one extremity of the arc does not belong to the graph nodes
void gum::learning::StructuralConstraintDiGraph::modifyGraphAlone ( const GraphChange change)

notify the constraint of a modification of the graph

Warning
If an already existing arc is added, or if a nonexisting arc is removed, nothing is done. In particular, no exception is raised.
Exceptions
InvalidNodeexception is thrown if an arc (x,y) is added and x or y does not belong to the graph nodes
StructuralConstraintDiGraph & gum::learning::StructuralConstraintDiGraph::operator= ( const StructuralConstraintDiGraph from)

copy operator

Definition at line 77 of file structuralConstraintDiGraph.cpp.

References _DiGraph__graph.

Referenced by gum::learning::StructuralConstraintDAG::operator=(), gum::learning::StructuralConstraintIndegree::operator=(), gum::learning::StructuralConstraintSliceOrder::operator=(), and ~StructuralConstraintDiGraph().

77  {
78  if (this != &from) { _DiGraph__graph = from._DiGraph__graph; }
79  return *this;
80  }
DiGraph _DiGraph__graph
the DiGraph on which we perform checks

+ Here is the caller graph for this function:

StructuralConstraintDiGraph & gum::learning::StructuralConstraintDiGraph::operator= ( StructuralConstraintDiGraph &&  from)

move operator

Definition at line 84 of file structuralConstraintDiGraph.cpp.

References _DiGraph__graph.

84  {
85  if (this != &from) { _DiGraph__graph = std::move(from._DiGraph__graph); }
86  return *this;
87  }
DiGraph _DiGraph__graph
the DiGraph on which we perform checks
void gum::learning::StructuralConstraintDiGraph::setGraph ( Size  nb_nodes)

sets a new empty graph from which we will perform checkings

Referenced by gum::learning::StructuralConstraintDAG::StructuralConstraintDAG(), and StructuralConstraintDiGraph().

+ Here is the caller graph for this function:

void gum::learning::StructuralConstraintDiGraph::setGraphAlone ( const DiGraph graph)

sets a new graph from which we will perform checkings

Member Data Documentation

DiGraph gum::learning::StructuralConstraintDiGraph::_DiGraph__graph
protected

the DiGraph on which we perform checks

Definition at line 191 of file structuralConstraintDiGraph.h.

Referenced by operator=().


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