The base class for structural constraints imposed by DAGs. More...

#include <structuralConstraintDAG.h>

Inheritance diagram for gum::learning::StructuralConstraintDAG:

Collaboration diagram for gum::learning::StructuralConstraintDAG:

Public Types
using	constraints

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

Protected Attributes
DAGCycleDetector	_DAG_cycle_detector_
	the cycle detector used to check quickly graph modifications

Detailed Description

The base class for structural constraints imposed by DAGs.

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 68 of file structuralConstraintDAG.h.

Member Typedef Documentation

◆ constraints

using gum::learning::StructuralConstraintSetStatic< StructuralConstraintDiGraph, OTHER_CONSTRAINTS >::constraints

inherited

Definition at line 425 of file structuralConstraintSetStatic.h.

Constructor & Destructor Documentation

◆ StructuralConstraintDAG() [1/5]

gum::learning::StructuralConstraintDAG::StructuralConstraintDAG ( )

default constructor

Definition at line 59 of file structuralConstraintDAG.cpp.

59{ GUM_CONSTRUCTOR(StructuralConstraintDAG); }

gum::learning::StructuralConstraintDAG::StructuralConstraintDAG

StructuralConstraintDAG()

default constructor

Definition structuralConstraintDAG.cpp:59

References StructuralConstraintDAG().

Referenced by StructuralConstraintDAG(), StructuralConstraintDAG(), StructuralConstraintDAG(), StructuralConstraintDAG(), StructuralConstraintDAG(), ~StructuralConstraintDAG(), operator=(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StructuralConstraintDAG() [2/5]

gum::learning::StructuralConstraintDAG::StructuralConstraintDAG ( Size nb_nodes )

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

Definition at line 62 of file structuralConstraintDAG.cpp.

                                                                  :
        StructuralConstraintDiGraph(nb_nodes) {
      StructuralConstraintDiGraph::setGraph(nb_nodes);
 
      DAG g;
      for (NodeId i = 0; i < nb_nodes; ++i) {
        g.addNodeWithId(i);
      }
      _DAG_cycle_detector_.setDAG(g);
 
      GUM_CONSTRUCTOR(StructuralConstraintDAG);
    }

References StructuralConstraintDAG(), _DAG_cycle_detector_, gum::NodeGraphPart::addNodeWithId(), and gum::learning::StructuralConstraintDiGraph::setGraph().

Here is the call graph for this function:

◆ StructuralConstraintDAG() [3/5]

gum::learning::StructuralConstraintDAG::StructuralConstraintDAG ( const DAG & graph )

constructor starting with a given graph

Definition at line 76 of file structuralConstraintDAG.cpp.

                                                                     {
      StructuralConstraintDiGraph::setGraph(graph);
      _DAG_cycle_detector_.setDAG(graph);
 
      GUM_CONSTRUCTOR(StructuralConstraintDAG);
    }

References StructuralConstraintDAG(), _DAG_cycle_detector_, and gum::learning::StructuralConstraintDiGraph::setGraph().

Here is the call graph for this function:

◆ StructuralConstraintDAG() [4/5]

gum::learning::StructuralConstraintDAG::StructuralConstraintDAG ( const StructuralConstraintDAG & from )

copy constructor

Definition at line 84 of file structuralConstraintDAG.cpp.

                                                                                        :
        StructuralConstraintDiGraph(from), _DAG_cycle_detector_(from._DAG_cycle_detector_) {
      GUM_CONS_CPY(StructuralConstraintDAG);
    }

References StructuralConstraintDAG(), and _DAG_cycle_detector_.

Here is the call graph for this function:

◆ StructuralConstraintDAG() [5/5]

gum::learning::StructuralConstraintDAG::StructuralConstraintDAG ( StructuralConstraintDAG && from )

move constructor

Definition at line 90 of file structuralConstraintDAG.cpp.

                                                                                   :
        StructuralConstraintDiGraph(std::move(from)),
        _DAG_cycle_detector_(std::move(from._DAG_cycle_detector_)) {
      GUM_CONS_MOV(StructuralConstraintDAG);
    }

References StructuralConstraintDAG(), and _DAG_cycle_detector_.

Here is the call graph for this function:

◆ ~StructuralConstraintDAG()

gum::learning::StructuralConstraintDAG::~StructuralConstraintDAG ( )

virtual

destructor

Definition at line 97 of file structuralConstraintDAG.cpp.

97{ GUM_DESTRUCTOR(StructuralConstraintDAG); }

References StructuralConstraintDAG().

Here is the call graph for this function:

Member Function Documentation

◆ checkArcAddition()

bool gum::learning::StructuralConstraintSetStatic< StructuralConstraintDiGraph, OTHER_CONSTRAINTS >::checkArcAddition	(	NodeId	x,
		NodeId	y ) const

inherited

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

◆ checkArcAdditionAlone()

bool gum::learning::StructuralConstraintDAG::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 and would not create a cycle

◆ checkArcDeletion()

bool gum::learning::StructuralConstraintSetStatic< StructuralConstraintDiGraph, OTHER_CONSTRAINTS >::checkArcDeletion	(	NodeId	x,
		NodeId	y ) const

inherited

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

◆ checkArcDeletionAlone()

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

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

◆ checkArcReversal()

bool gum::learning::StructuralConstraintSetStatic< StructuralConstraintDiGraph, OTHER_CONSTRAINTS >::checkArcReversal	(	NodeId	x,
		NodeId	y ) const

inherited

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

◆ checkArcReversalAlone()

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

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

An arc (x,y) can be reversed if and only if it exists and, after deleting it, the addition of arc (y,x) does not induce a directed cycle.

◆ checkModification()

bool gum::learning::StructuralConstraintSetStatic< StructuralConstraintDiGraph, OTHER_CONSTRAINTS >::checkModification ( const ArcAddition & change ) const

inherited

checks whether the constraints enable to add an arc

◆ checkModificationAlone() [1/4]

bool gum::learning::StructuralConstraintDAG::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() [2/4]

bool gum::learning::StructuralConstraintDAG::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() [3/4]

bool gum::learning::StructuralConstraintDAG::checkModificationAlone ( const ArcReversal & change ) const

checks whether the constraints enable to reverse an arc

An arc can be reversed if, after deleting arc (x,y), the addition of arc (y,x) does not induce a directed cycle.

◆ checkModificationAlone() [4/4]

bool gum::learning::StructuralConstraintDAG::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 and would not create a cycle. An arc can be removed if and only if the arc exists. An arc can be reversed if, after deleting arc (x,y), the addition of arc (y,x) does not induce a directed cycle.

◆ isAlwaysInvalid()

bool gum::learning::StructuralConstraintSetStatic< StructuralConstraintDiGraph, OTHER_CONSTRAINTS >::isAlwaysInvalid ( const GraphChange & change ) const

inherited

indicates whether a change will always violate the constraint

◆ isAlwaysInvalidAlone()

bool gum::learning::StructuralConstraintDAG::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.

◆ modifyGraph()

void gum::learning::StructuralConstraintSetStatic< StructuralConstraintDiGraph, OTHER_CONSTRAINTS >::modifyGraph ( const ArcAddition & change )

inherited

notify the constraint of a modification of the graph

◆ modifyGraphAlone() [1/4]

void gum::learning::StructuralConstraintDAG::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
InvalidDirectedCycle	exception is thrown if any (directed) cycle is created by the arc addition.

◆ modifyGraphAlone() [2/4]

void gum::learning::StructuralConstraintDAG::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::StructuralConstraintDAG::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
InvalidDirectedCycle	exception is thrown if any (directed) cycle is created by the arc reversal.

◆ modifyGraphAlone() [4/4]

void gum::learning::StructuralConstraintDAG::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
InvalidDirectedCycle	exception is thrown if any (directed) cycle is created by an arc addition or reversal.

◆ operator=() [1/2]

StructuralConstraintDAG & gum::learning::StructuralConstraintDAG::operator= ( const StructuralConstraintDAG & from )

copy operator

Definition at line 101 of file structuralConstraintDAG.cpp.

                                                                            {
      if (this != &from) {
        StructuralConstraintDiGraph::operator=(from);
        _DAG_cycle_detector_ = from._DAG_cycle_detector_;
      }
      return *this;
    }

References StructuralConstraintDAG(), _DAG_cycle_detector_, and gum::learning::StructuralConstraintDiGraph::operator=().

Here is the call graph for this function:

◆ operator=() [2/2]

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

move operator

Definition at line 110 of file structuralConstraintDAG.cpp.

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

References StructuralConstraintDAG(), _DAG_cycle_detector_, and gum::learning::StructuralConstraintDiGraph::operator=().

Here is the call graph for this function:

◆ setGraph() [1/3]

void gum::learning::StructuralConstraintDAG::setGraph ( const DAG & graph )

sets a new graph from which we will perform checkings

◆ setGraph() [2/3]

void gum::learning::StructuralConstraintDAG::setGraph ( Size nb_nodes )

sets a new empty graph from which we will perform checkings

◆ setGraph() [3/3]

void gum::learning::StructuralConstraintSetStatic< StructuralConstraintDiGraph, OTHER_CONSTRAINTS >::setGraph ( const DiGraph & graph )

inherited

sets a new graph from which we will perform checkings

◆ setGraphAlone() [1/2]

void gum::learning::StructuralConstraintDAG::setGraphAlone ( const DiGraph & graph )

sets a new graph from which we will perform checkings

◆ setGraphAlone() [2/2]

void gum::learning::StructuralConstraintDAG::setGraphAlone ( Size nb_nodes )

sets a new empty graph from which we will perform checkings

Member Data Documentation

◆ _DAG_cycle_detector_

DAGCycleDetector gum::learning::StructuralConstraintDAG::_DAG_cycle_detector_

protected

the cycle detector used to check quickly graph modifications

Definition at line 227 of file structuralConstraintDAG.h.

Referenced by StructuralConstraintDAG(), StructuralConstraintDAG(), StructuralConstraintDAG(), StructuralConstraintDAG(), operator=(), and operator=().

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

agrum/BN/learning/constraints/structuralConstraintDAG.h
agrum/BN/learning/constraints/structuralConstraintDAG.cpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ constraints

Constructor & Destructor Documentation

◆ StructuralConstraintDAG() [1/5]

◆ StructuralConstraintDAG() [2/5]

◆ StructuralConstraintDAG() [3/5]

◆ StructuralConstraintDAG() [4/5]

◆ StructuralConstraintDAG() [5/5]

◆ ~StructuralConstraintDAG()

Member Function Documentation

◆ checkArcAddition()

◆ checkArcAdditionAlone()

◆ checkArcDeletion()

◆ checkArcDeletionAlone()

◆ checkArcReversal()

◆ checkArcReversalAlone()

◆ checkModification()

◆ checkModificationAlone() [1/4]

◆ checkModificationAlone() [2/4]

◆ checkModificationAlone() [3/4]

◆ checkModificationAlone() [4/4]

◆ isAlwaysInvalid()

◆ isAlwaysInvalidAlone()

◆ modifyGraph()

◆ modifyGraphAlone() [1/4]

◆ modifyGraphAlone() [2/4]

◆ modifyGraphAlone() [3/4]

◆ modifyGraphAlone() [4/4]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setGraph() [1/3]

◆ setGraph() [2/3]

◆ setGraph() [3/3]

◆ setGraphAlone() [1/2]

◆ setGraphAlone() [2/2]

Member Data Documentation

◆ _DAG_cycle_detector_