aGrUM  0.13.2
gum::learning::StructuralConstraintUndiGraph Class Reference

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

#include <structuralConstraintUndiGraph.h>

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

Public Member Functions

Constructors / Destructors
 StructuralConstraintUndiGraph ()
 default constructor More...
 
 StructuralConstraintUndiGraph (Size nb_nodes)
 constructor starting with an empty graph with a given number of nodes More...
 
 StructuralConstraintUndiGraph (const UndiGraph &graph)
 constructor starting with a given graph More...
 
 StructuralConstraintUndiGraph (const StructuralConstraintUndiGraph &from)
 copy constructor More...
 
 StructuralConstraintUndiGraph (StructuralConstraintUndiGraph &&from)
 move constructor More...
 
virtual ~StructuralConstraintUndiGraph ()
 destructor More...
 
Operators
StructuralConstraintUndiGraphoperator= (const StructuralConstraintUndiGraph &from)
 copy operator More...
 
StructuralConstraintUndiGraphoperator= (StructuralConstraintUndiGraph &&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 UndiGraph &graph)
 sets a new graph from which we will perform checkings More...
 
void modifyGraphAlone (const EdgeAddition &change)
 notify the constraint of a modification of the graph More...
 
void modifyGraphAlone (const EdgeDeletion &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 checkEdgeAdditionAlone (NodeId x, NodeId y) const
 checks whether the constraints enable to add edge (x,y) More...
 
bool checkEdgeDeletionAlone (NodeId x, NodeId y) const
 checks whether the constraints enable to remove edge (x,y) More...
 
bool checkModificationAlone (const GraphChange &change) const
 checks whether the constraints enable to perform a graph change More...
 
bool checkModificationAlone (const EdgeAddition &change) const
 checks whether the constraints enable to add an edge More...
 
bool checkModificationAlone (const EdgeDeletion &change) const
 checks whether the constraints enable to remove an edge More...
 

Public Types

using allConstraints = __ConstraintSet< void >
 

Protected Attributes

UndiGraph _UndiGraph__graph
 the UndiGraph on which we perform checks More...
 

Detailed Description

The base class for structural constraints used by learning algorithms that learn an undirected graph structure.

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

Definition at line 47 of file structuralConstraintUndiGraph.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::StructuralConstraintUndiGraph::StructuralConstraintUndiGraph ( )

default constructor

Definition at line 39 of file structuralConstraintUndiGraph.cpp.

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

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

Definition at line 44 of file structuralConstraintUndiGraph.cpp.

References setGraph().

44  {
45  setGraph(nb_nodes);
46  GUM_CONSTRUCTOR(StructuralConstraintUndiGraph);
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::StructuralConstraintUndiGraph::StructuralConstraintUndiGraph ( const UndiGraph graph)

constructor starting with a given graph

Definition at line 50 of file structuralConstraintUndiGraph.cpp.

References setGraph().

51  {
52  setGraph(graph);
53  GUM_CONSTRUCTOR(StructuralConstraintUndiGraph);
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::StructuralConstraintUndiGraph::StructuralConstraintUndiGraph ( const StructuralConstraintUndiGraph from)

copy constructor

Definition at line 57 of file structuralConstraintUndiGraph.cpp.

58  :
59  _UndiGraph__graph(from._UndiGraph__graph) {
60  GUM_CONS_CPY(StructuralConstraintUndiGraph);
61  }
UndiGraph _UndiGraph__graph
the UndiGraph on which we perform checks
gum::learning::StructuralConstraintUndiGraph::StructuralConstraintUndiGraph ( StructuralConstraintUndiGraph &&  from)

move constructor

Definition at line 64 of file structuralConstraintUndiGraph.cpp.

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

destructor

Definition at line 71 of file structuralConstraintUndiGraph.cpp.

References operator=().

71  {
72  GUM_DESTRUCTOR(StructuralConstraintUndiGraph);
73  }

+ Here is the call graph for this function:

Member Function Documentation

bool gum::learning::StructuralConstraintUndiGraph::checkEdgeAdditionAlone ( NodeId  x,
NodeId  y 
) const

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

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

bool gum::learning::StructuralConstraintUndiGraph::checkEdgeDeletionAlone ( NodeId  x,
NodeId  y 
) const

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

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

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

checks whether the constraints enable to perform a graph change

An edge can be added if and only if its extremal nodes belong to the graph and the edge does not already exist. An edge can be removed if and only if the edge exists.

bool gum::learning::StructuralConstraintUndiGraph::checkModificationAlone ( const EdgeAddition change) const

checks whether the constraints enable to add an edge

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

bool gum::learning::StructuralConstraintUndiGraph::checkModificationAlone ( const EdgeDeletion change) const

checks whether the constraints enable to remove an edge

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

bool gum::learning::StructuralConstraintUndiGraph::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 edge (X,Y) addition is considered, the learning algorithm may discard this change because it violates the structural constraint, but, later on, other edge removals may induce that the edge 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::StructuralConstraintUndiGraph::modifyGraphAlone ( const EdgeAddition change)

notify the constraint of a modification of the graph

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

notify the constraint of a modification of the graph

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

notify the constraint of a modification of the graph

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

copy operator

Definition at line 77 of file structuralConstraintUndiGraph.cpp.

References _UndiGraph__graph.

Referenced by ~StructuralConstraintUndiGraph().

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

+ Here is the caller graph for this function:

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

move operator

Definition at line 84 of file structuralConstraintUndiGraph.cpp.

References _UndiGraph__graph.

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

sets a new empty graph from which we will perform checkings

Referenced by StructuralConstraintUndiGraph().

+ Here is the caller graph for this function:

void gum::learning::StructuralConstraintUndiGraph::setGraphAlone ( const UndiGraph graph)

sets a new graph from which we will perform checkings

Member Data Documentation

UndiGraph gum::learning::StructuralConstraintUndiGraph::_UndiGraph__graph
protected

the UndiGraph on which we perform checks

Definition at line 173 of file structuralConstraintUndiGraph.h.

Referenced by operator=().


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