gum::learning::StructuralConstraintMandatoryArcs Class Reference

the structural constraint indicating that some arcs shall never be removed or reversed More...

#include <structuralConstraintMandatoryArcs.h>

Inheritance diagram for gum::learning::StructuralConstraintMandatoryArcs:

Collaboration diagram for gum::learning::StructuralConstraintMandatoryArcs:

Public Member Functions
Constructors / Destructors
	StructuralConstraintMandatoryArcs ()
	default constructor More...
	StructuralConstraintMandatoryArcs (const DiGraph &graph)
	constructor starting with a given graph More...
	StructuralConstraintMandatoryArcs (const StructuralConstraintMandatoryArcs &from)
	copy constructor More...
	StructuralConstraintMandatoryArcs (StructuralConstraintMandatoryArcs &&from)
	move constructor More...
virtual	~StructuralConstraintMandatoryArcs ()
	destructor More...
Operators
StructuralConstraintMandatoryArcs &	operator= (const StructuralConstraintMandatoryArcs &from)
	copy operator More...
StructuralConstraintMandatoryArcs &	operator= (StructuralConstraintMandatoryArcs &&from)
	move operator More...
Specific Accessors / Modifiers
void	setArcs (const ArcSet &set)
	assign a set of forbidden arcs More...
void	addArc (const Arc &arc)
	assign a new forbidden arc More...
void	eraseArc (const Arc &arc)
	remove a forbidden arc More...
const ArcSet &	arcs () const
	returns the set of mandatory arcs 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
ArcSet	_MandatoryArcs__mandatory_arcs
	the MandatoryArcs on which we perform checks More...

Detailed Description

the structural constraint indicating that some arcs shall never be removed or reversed

Definition at line 46 of file structuralConstraintMandatoryArcs.h.

Member Typedef Documentation

allConstraints

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

inherited

Definition at line 42 of file structuralConstraint.h.

Constructor & Destructor Documentation

StructuralConstraintMandatoryArcs() [1/4]

gum::learning::StructuralConstraintMandatoryArcs::StructuralConstraintMandatoryArcs

(

)

default constructor

Definition at line 42 of file structuralConstraintMandatoryArcs.cpp.

                                                                         {
      GUM_CONSTRUCTOR(StructuralConstraintMandatoryArcs);
    }

StructuralConstraintMandatoryArcs() [2/4]

gum::learning::StructuralConstraintMandatoryArcs::StructuralConstraintMandatoryArcs

(

const DiGraph &

graph

)

constructor starting with a given graph

Definition at line 47 of file structuralConstraintMandatoryArcs.cpp.

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

StructuralConstraintMandatoryArcs() [3/4]

gum::learning::StructuralConstraintMandatoryArcs::StructuralConstraintMandatoryArcs

(

const StructuralConstraintMandatoryArcs &

from

)

copy constructor

Definition at line 54 of file structuralConstraintMandatoryArcs.cpp.

                                                      :
        _MandatoryArcs__mandatory_arcs(from._MandatoryArcs__mandatory_arcs) {
      GUM_CONS_CPY(StructuralConstraintMandatoryArcs);
    }

StructuralConstraintMandatoryArcs() [4/4]

gum::learning::StructuralConstraintMandatoryArcs::StructuralConstraintMandatoryArcs

(

StructuralConstraintMandatoryArcs &&

from

)

move constructor

Definition at line 61 of file structuralConstraintMandatoryArcs.cpp.

                                                 :
        _MandatoryArcs__mandatory_arcs(
           std::move(from._MandatoryArcs__mandatory_arcs)) {
      GUM_CONS_MOV(StructuralConstraintMandatoryArcs);
    }

~StructuralConstraintMandatoryArcs()

gum::learning::StructuralConstraintMandatoryArcs::~StructuralConstraintMandatoryArcs ( )

virtual

destructor

Definition at line 69 of file structuralConstraintMandatoryArcs.cpp.

References operator=().

                                                                          {
      GUM_DESTRUCTOR(StructuralConstraintMandatoryArcs);
    }

Here is the call graph for this function:

Member Function Documentation

addArc()

void gum::learning::StructuralConstraintMandatoryArcs::addArc

(

const Arc &

arc

)

assign a new forbidden arc

Referenced by gum::learning::genericBNLearner::addMandatoryArc().

Here is the caller graph for this function:

arcs()

const ArcSet& gum::learning::StructuralConstraintMandatoryArcs::arcs

(

)

const

returns the set of mandatory arcs

Referenced by gum::learning::genericBNLearner::__learnDAG(), and gum::learning::genericBNLearner::__prepare_miic_3off2().

Here is the caller graph for this function:

checkArcAdditionAlone()

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

eraseArc()

void gum::learning::StructuralConstraintMandatoryArcs::eraseArc

(

const Arc &

arc

)

remove a forbidden arc

Referenced by gum::learning::genericBNLearner::eraseMandatoryArc().

Here is the caller graph for this function:

isAlwaysInvalidAlone()

bool gum::learning::StructuralConstraintMandatoryArcs::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::StructuralConstraintMandatoryArcs::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::StructuralConstraintMandatoryArcs::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::StructuralConstraintMandatoryArcs::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::StructuralConstraintMandatoryArcs::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]

StructuralConstraintMandatoryArcs & gum::learning::StructuralConstraintMandatoryArcs::operator=

(

const StructuralConstraintMandatoryArcs &

from

)

copy operator

Definition at line 75 of file structuralConstraintMandatoryArcs.cpp.

References _MandatoryArcs__mandatory_arcs.

Referenced by ~StructuralConstraintMandatoryArcs().

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

Here is the caller graph for this function:

operator=() [2/2]

StructuralConstraintMandatoryArcs & gum::learning::StructuralConstraintMandatoryArcs::operator=

(

StructuralConstraintMandatoryArcs &&

from

)

move operator

Definition at line 84 of file structuralConstraintMandatoryArcs.cpp.

References _MandatoryArcs__mandatory_arcs.

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

setArcs()

void gum::learning::StructuralConstraintMandatoryArcs::setArcs

(

const ArcSet &

set

)

assign a set of forbidden arcs

Referenced by gum::learning::genericBNLearner::setMandatoryArcs().

Here is the caller graph for this function:

setGraphAlone()

void gum::learning::StructuralConstraintMandatoryArcs::setGraphAlone

(

const DiGraph &

graph

)

sets a new graph from which we will perform checkings

Member Data Documentation

_MandatoryArcs__mandatory_arcs

ArcSet gum::learning::StructuralConstraintMandatoryArcs::_MandatoryArcs__mandatory_arcs

protected

the MandatoryArcs on which we perform checks

Definition at line 198 of file structuralConstraintMandatoryArcs.h.

Referenced by operator=().

---

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

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