aGrUM  0.13.2
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
StructuralConstraintMandatoryArcsoperator= (const StructuralConstraintMandatoryArcs &from)
 copy operator More...
 
StructuralConstraintMandatoryArcsoperator= (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 ArcSetarcs () 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 43 of file structuralConstraintMandatoryArcs.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::StructuralConstraintMandatoryArcs::StructuralConstraintMandatoryArcs ( )

default constructor

Definition at line 39 of file structuralConstraintMandatoryArcs.cpp.

39  {
40  GUM_CONSTRUCTOR(StructuralConstraintMandatoryArcs);
41  }
gum::learning::StructuralConstraintMandatoryArcs::StructuralConstraintMandatoryArcs ( const DiGraph graph)

constructor starting with a given graph

Definition at line 44 of file structuralConstraintMandatoryArcs.cpp.

45  {
46  setGraph(graph);
47  GUM_CONSTRUCTOR(StructuralConstraintMandatoryArcs);
48  }
gum::learning::StructuralConstraintMandatoryArcs::StructuralConstraintMandatoryArcs ( const StructuralConstraintMandatoryArcs from)

copy constructor

Definition at line 51 of file structuralConstraintMandatoryArcs.cpp.

52  :
53  _MandatoryArcs__mandatory_arcs(from._MandatoryArcs__mandatory_arcs) {
55  }
ArcSet _MandatoryArcs__mandatory_arcs
the MandatoryArcs on which we perform checks
gum::learning::StructuralConstraintMandatoryArcs::StructuralConstraintMandatoryArcs ( StructuralConstraintMandatoryArcs &&  from)

move constructor

Definition at line 58 of file structuralConstraintMandatoryArcs.cpp.

59  :
61  std::move(from._MandatoryArcs__mandatory_arcs)) {
63  }
ArcSet _MandatoryArcs__mandatory_arcs
the MandatoryArcs on which we perform checks
gum::learning::StructuralConstraintMandatoryArcs::~StructuralConstraintMandatoryArcs ( )
virtual

destructor

Definition at line 66 of file structuralConstraintMandatoryArcs.cpp.

References operator=().

66  {
67  GUM_DESTRUCTOR(StructuralConstraintMandatoryArcs);
68  }

+ Here is the call graph for this function:

Member Function Documentation

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:

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:

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.

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.

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.

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.

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.

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.

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.

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:

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.

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
InvalidNodeexception is thrown if an arc (x,y) is added and x or y does not belong to the graph nodes
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.
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
InvalidNodeexception is thrown if at least one extremity of the arc does not belong to the graph nodes
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
InvalidNodeexception is thrown if an arc (x,y) is added and x or y does not belong to the graph nodes
StructuralConstraintMandatoryArcs & gum::learning::StructuralConstraintMandatoryArcs::operator= ( const StructuralConstraintMandatoryArcs from)

copy operator

Definition at line 72 of file structuralConstraintMandatoryArcs.cpp.

References _MandatoryArcs__mandatory_arcs.

Referenced by ~StructuralConstraintMandatoryArcs().

72  {
73  if (this != &from) {
74  _MandatoryArcs__mandatory_arcs = from._MandatoryArcs__mandatory_arcs;
75  }
76  return *this;
77  }
ArcSet _MandatoryArcs__mandatory_arcs
the MandatoryArcs on which we perform checks

+ Here is the caller graph for this function:

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

move operator

Definition at line 81 of file structuralConstraintMandatoryArcs.cpp.

References _MandatoryArcs__mandatory_arcs.

81  {
82  if (this != &from) {
84  std::move(from._MandatoryArcs__mandatory_arcs);
85  }
86  return *this;
87  }
ArcSet _MandatoryArcs__mandatory_arcs
the MandatoryArcs on which we perform checks
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:

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

sets a new graph from which we will perform checkings

Member Data Documentation

ArcSet gum::learning::StructuralConstraintMandatoryArcs::_MandatoryArcs__mandatory_arcs
protected

the MandatoryArcs on which we perform checks

Definition at line 195 of file structuralConstraintMandatoryArcs.h.

Referenced by operator=().


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