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
StructuralConstraintDiGraph &	operator= (const StructuralConstraintDiGraph &from)
	copy operator More...
StructuralConstraintDiGraph &	operator= (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 51 of file structuralConstraintDiGraph.h.

Member Typedef Documentation

allConstraints

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

inherited

Definition at line 42 of file structuralConstraint.h.

Constructor & Destructor Documentation

StructuralConstraintDiGraph() [1/5]

gum::learning::StructuralConstraintDiGraph::StructuralConstraintDiGraph

(

)

default constructor

Definition at line 42 of file structuralConstraintDiGraph.cpp.

                                                             {
      GUM_CONSTRUCTOR(StructuralConstraintDiGraph);
    }

StructuralConstraintDiGraph() [2/5]

gum::learning::StructuralConstraintDiGraph::StructuralConstraintDiGraph

(

Size

nb_nodes

)

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

Definition at line 47 of file structuralConstraintDiGraph.cpp.

References setGraph().

                                                                          {
      setGraph(nb_nodes);
      GUM_CONSTRUCTOR(StructuralConstraintDiGraph);
    }

Here is the call graph for this function:

StructuralConstraintDiGraph() [3/5]

gum::learning::StructuralConstraintDiGraph::StructuralConstraintDiGraph

(

const DiGraph &

graph

)

constructor starting with a given graph

Definition at line 53 of file structuralConstraintDiGraph.cpp.

References setGraph().

                             {
      setGraph(graph);
      GUM_CONSTRUCTOR(StructuralConstraintDiGraph);
    }

Here is the call graph for this function:

StructuralConstraintDiGraph() [4/5]

gum::learning::StructuralConstraintDiGraph::StructuralConstraintDiGraph

(

const StructuralConstraintDiGraph &

from

)

copy constructor

Definition at line 60 of file structuralConstraintDiGraph.cpp.

                                                :
        _DiGraph__graph(from._DiGraph__graph) {
      GUM_CONS_CPY(StructuralConstraintDiGraph);
    }

StructuralConstraintDiGraph() [5/5]

gum::learning::StructuralConstraintDiGraph::StructuralConstraintDiGraph

(

StructuralConstraintDiGraph &&

from

)

move constructor

Definition at line 67 of file structuralConstraintDiGraph.cpp.

                                           :
        _DiGraph__graph(std::move(from._DiGraph__graph)) {
      GUM_CONS_MOV(StructuralConstraintDiGraph);
    }

~StructuralConstraintDiGraph()

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

virtual

destructor

Definition at line 74 of file structuralConstraintDiGraph.cpp.

References operator=().

                                                              {
      GUM_DESTRUCTOR(StructuralConstraintDiGraph);
    }

Here is the call graph for this function:

Member Function Documentation

checkArcAdditionAlone()

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.

checkArcDeletionAlone()

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.

checkArcReversalAlone()

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.

checkModificationAlone() [1/4]

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.

checkModificationAlone() [2/4]

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.

checkModificationAlone() [3/4]

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.

checkModificationAlone() [4/4]

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.

isAlwaysInvalidAlone()

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.

modifyGraphAlone() [1/4]

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

InvalidNode

exception is thrown if an arc (x,y) is added and x or y does not belong to the graph nodes

modifyGraphAlone() [2/4]

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.

modifyGraphAlone() [3/4]

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

InvalidNode

exception is thrown if at least one extremity of the arc does not belong to the graph nodes

modifyGraphAlone() [4/4]

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

InvalidNode

exception is thrown if an arc (x,y) is added and x or y does not belong to the graph nodes

operator=() [1/2]

StructuralConstraintDiGraph & gum::learning::StructuralConstraintDiGraph::operator=

(

const StructuralConstraintDiGraph &

from

)

copy operator

Definition at line 80 of file structuralConstraintDiGraph.cpp.

References _DiGraph__graph.

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

                                                                                    {
      if (this != &from) { _DiGraph__graph = from._DiGraph__graph; }
      return *this;
    }

Here is the caller graph for this function:

operator=() [2/2]

StructuralConstraintDiGraph & gum::learning::StructuralConstraintDiGraph::operator=

(

StructuralConstraintDiGraph &&

from

)

move operator

Definition at line 87 of file structuralConstraintDiGraph.cpp.

References _DiGraph__graph.

                                                                               {
      if (this != &from) { _DiGraph__graph = std::move(from._DiGraph__graph); }
      return *this;
    }

setGraph()

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:

setGraphAlone()

void gum::learning::StructuralConstraintDiGraph::setGraphAlone

(

const DiGraph &

graph

)

sets a new graph from which we will perform checkings

Member Data Documentation

_DiGraph__graph

DiGraph gum::learning::StructuralConstraintDiGraph::_DiGraph__graph

protected

the DiGraph on which we perform checks

Definition at line 194 of file structuralConstraintDiGraph.h.

Referenced by operator=().

---

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

• agrum/learning/constraints/structuralConstraintDiGraph.h
• agrum/learning/constraints/structuralConstraintDiGraph.cpp