aGrUM
3.2.0
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
structuralConstraintMandatoryArcs.cpp
Go to the documentation of this file.
1
/****************************************************************************
2
* This file is part of the aGrUM/pyAgrum library. *
3
* *
4
* Copyright (c) 2005-2026 by *
5
* - Pierre-Henri WUILLEMIN(_at_LIP6) *
6
* - Christophe GONZALES(_at_AMU) *
7
* *
8
* The aGrUM/pyAgrum library is free software; you can redistribute it *
9
* and/or modify it under the terms of either : *
10
* *
11
* - the GNU Lesser General Public License as published by *
12
* the Free Software Foundation, either version 3 of the License, *
13
* or (at your option) any later version, *
14
* - the MIT license (MIT), *
15
* - or both in dual license, as here. *
16
* *
17
* (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html) *
18
* *
19
* This aGrUM/pyAgrum library is distributed in the hope that it will be *
20
* useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
21
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
22
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *
23
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
24
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, *
25
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR *
26
* OTHER DEALINGS IN THE SOFTWARE. *
27
* *
28
* See LICENCES for more details. *
29
* *
30
* SPDX-FileCopyrightText: Copyright 2005-2026 *
31
* - Pierre-Henri WUILLEMIN(_at_LIP6) *
32
* - Christophe GONZALES(_at_AMU) *
33
* SPDX-License-Identifier: LGPL-3.0-or-later OR MIT *
34
* *
35
* Contact : info_at_agrum_dot_org *
36
* homepage : http://agrum.gitlab.io *
37
* gitlab : https://gitlab.com/agrumery/agrum *
38
* *
39
****************************************************************************/
40
41
48
49
#include <
agrum/BN/learning/constraints/structuralConstraintMandatoryArcs.h
>
50
52
#ifdef GUM_NO_INLINE
53
# include <
agrum/BN/learning/constraints/structuralConstraintMandatoryArcs_inl.h
>
54
#endif
/* GUM_NO_INLINE */
55
56
namespace
gum
{
57
58
namespace
learning
{
59
61
StructuralConstraintMandatoryArcs::StructuralConstraintMandatoryArcs
() {
62
GUM_CONSTRUCTOR(
StructuralConstraintMandatoryArcs
);
63
}
64
66
StructuralConstraintMandatoryArcs::StructuralConstraintMandatoryArcs
(
const
DiGraph
&
graph
) {
67
setGraph(
graph
);
68
GUM_CONSTRUCTOR(
StructuralConstraintMandatoryArcs
);
69
}
70
72
StructuralConstraintMandatoryArcs::StructuralConstraintMandatoryArcs
(
73
const
StructuralConstraintMandatoryArcs
& from) :
74
_MandatoryArcs_mandatory_arcs_
(from.
_MandatoryArcs_mandatory_arcs_
) {
75
GUM_CONS_CPY(
StructuralConstraintMandatoryArcs
);
76
}
77
79
StructuralConstraintMandatoryArcs::StructuralConstraintMandatoryArcs
(
80
StructuralConstraintMandatoryArcs
&& from) :
81
_MandatoryArcs_mandatory_arcs_
(
std
::move(from.
_MandatoryArcs_mandatory_arcs_
)) {
82
GUM_CONS_MOV(
StructuralConstraintMandatoryArcs
);
83
}
84
86
StructuralConstraintMandatoryArcs::~StructuralConstraintMandatoryArcs
() {
87
GUM_DESTRUCTOR(
StructuralConstraintMandatoryArcs
);
88
}
89
91
StructuralConstraintMandatoryArcs
&
StructuralConstraintMandatoryArcs::operator=
(
92
const
StructuralConstraintMandatoryArcs
& from) {
93
if
(
this
!= &from) {
_MandatoryArcs_mandatory_arcs_
= from.
_MandatoryArcs_mandatory_arcs_
; }
94
return
*
this
;
95
}
96
98
StructuralConstraintMandatoryArcs
&
99
StructuralConstraintMandatoryArcs::operator=
(
StructuralConstraintMandatoryArcs
&& from) {
100
if
(
this
!= &from) {
101
_MandatoryArcs_mandatory_arcs_
= std::move(from._MandatoryArcs_mandatory_arcs_);
102
}
103
return
*
this
;
104
}
105
106
bool
107
StructuralConstraintMandatoryArcs::checkModificationAlone
(
const
GraphChange
& change)
const
{
108
switch
(change.
type
()) {
109
case
GraphChangeType::ARC_ADDITION
:
110
return
checkArcAdditionAlone
(change.
node1
(), change.
node2
());
111
112
case
GraphChangeType::ARC_DELETION
:
113
return
checkArcDeletionAlone
(change.
node1
(), change.
node2
());
114
115
case
GraphChangeType::ARC_REVERSAL
:
116
return
checkArcReversalAlone
(change.
node1
(), change.
node2
());
117
118
case
GraphChangeType::ARC_TRIANGLE_DELETION1
:
119
return
checkArcTriangleDeletion1Alone
(change.
node1
(), change.
node2
(), change.
node3
());
120
121
case
GraphChangeType::ARC_TRIANGLE_DELETION2
:
122
return
checkArcTriangleDeletion2Alone
(change.
node1
(), change.
node2
(), change.
node3
());
123
124
default :
125
GUM_ERROR
(
OperationNotAllowed
,
126
"Graph change operation "
127
<< change.
typeAsString
()
128
<<
" is not supported by the Mandatory Arcs structural constraint"
);
129
}
130
}
131
132
bool
StructuralConstraintMandatoryArcs::isAlwaysInvalidAlone
(
const
GraphChange
& change)
const
{
133
switch
(change.
type
()) {
134
case
GraphChangeType::ARC_ADDITION
:
return
false
;
135
136
case
GraphChangeType::ARC_DELETION
:
137
return
!
checkArcDeletionAlone
(change.
node1
(), change.
node2
());
138
139
case
GraphChangeType::ARC_REVERSAL
:
140
return
!
checkArcReversalAlone
(change.
node1
(), change.
node2
());
141
142
case
GraphChangeType::ARC_TRIANGLE_DELETION1
:
143
return
!
checkArcTriangleDeletion1Alone
(change.
node1
(), change.
node2
(), change.
node3
());
144
145
case
GraphChangeType::ARC_TRIANGLE_DELETION2
:
146
return
!
checkArcTriangleDeletion2Alone
(change.
node1
(), change.
node2
(), change.
node3
());
147
148
default :
149
GUM_ERROR
(
OperationNotAllowed
,
150
"Graph change operation "
151
<< change.
typeAsString
()
152
<<
" is not supported by the Mandatory Arcs structural constraint"
);
153
}
154
}
155
}
/* namespace learning */
156
157
}
/* namespace gum */
gum::DiGraph
Base class for all oriented graphs.
Definition
diGraph.h:132
OperationNotAllowed
Exception : operation not allowed.
gum::learning::GraphChange
Definition
graphChange.h:101
gum::learning::GraphChange::typeAsString
std::string typeAsString() const
returns a string corresponding to the type of the change
Definition
graphChange.cpp:302
gum::learning::GraphChange::node1
NodeId node1() const noexcept
returns the first node involved in the modification
gum::learning::GraphChange::type
GraphChangeType type() const noexcept
returns the type of the operation
gum::learning::GraphChange::node2
NodeId node2() const noexcept
returns the second node involved in the modification
gum::learning::GraphChange::node3
NodeId node3() const
returns the third node involved in the modification (if any)
gum::learning::StructuralConstraintMandatoryArcs
the structural constraint indicating that some arcs shall never be removed or reversed
Definition
structuralConstraintMandatoryArcs.h:65
gum::learning::StructuralConstraintMandatoryArcs::checkArcReversalAlone
bool checkArcReversalAlone(NodeId x, NodeId y) const
checks whether the constraints enable to reverse arc (x,y)
gum::learning::StructuralConstraintMandatoryArcs::checkArcDeletionAlone
bool checkArcDeletionAlone(NodeId x, NodeId y) const
checks whether the constraints enable to remove arc (x,y)
gum::learning::StructuralConstraintMandatoryArcs::operator=
StructuralConstraintMandatoryArcs & operator=(const StructuralConstraintMandatoryArcs &from)
copy operator
Definition
structuralConstraintMandatoryArcs.cpp:91
gum::learning::StructuralConstraintMandatoryArcs::checkModificationAlone
bool checkModificationAlone(const GraphChange &change) const
checks whether the constraints enable to perform a graph change
Definition
structuralConstraintMandatoryArcs.cpp:107
gum::learning::StructuralConstraintMandatoryArcs::StructuralConstraintMandatoryArcs
StructuralConstraintMandatoryArcs()
default constructor
Definition
structuralConstraintMandatoryArcs.cpp:61
gum::learning::StructuralConstraintMandatoryArcs::_MandatoryArcs_mandatory_arcs_
ArcSet _MandatoryArcs_mandatory_arcs_
the MandatoryArcs on which we perform checks
Definition
structuralConstraintMandatoryArcs.h:249
gum::learning::StructuralConstraintMandatoryArcs::checkArcTriangleDeletion1Alone
bool checkArcTriangleDeletion1Alone(NodeId node1, NodeId node2, NodeId node3) const
checks whether the constraints enable to apply an ArcTriangleDeletion1
gum::learning::StructuralConstraintMandatoryArcs::isAlwaysInvalidAlone
bool isAlwaysInvalidAlone(const GraphChange &change) const
indicates whether a change will always violate the constraint
Definition
structuralConstraintMandatoryArcs.cpp:132
gum::learning::StructuralConstraintMandatoryArcs::checkArcTriangleDeletion2Alone
bool checkArcTriangleDeletion2Alone(NodeId node1, NodeId node2, NodeId node3) const
checks whether the constraints enable to apply an ArcTriangleDeletion2
gum::learning::StructuralConstraintMandatoryArcs::checkArcAdditionAlone
bool checkArcAdditionAlone(NodeId x, NodeId y) const
checks whether the constraints enable to add arc (x,y)
gum::learning::StructuralConstraintMandatoryArcs::~StructuralConstraintMandatoryArcs
virtual ~StructuralConstraintMandatoryArcs()
destructor
Definition
structuralConstraintMandatoryArcs.cpp:86
GUM_ERROR
#define GUM_ERROR(type, msg)
Definition
exceptions.h:76
gum::graph
Definition
bayesBall.h:79
gum::learning
include the inlined functions if necessary
Definition
CSVParser.h:55
gum::learning::GraphChangeType::ARC_DELETION
@ ARC_DELETION
Definition
graphChange.h:76
gum::learning::GraphChangeType::ARC_REVERSAL
@ ARC_REVERSAL
Definition
graphChange.h:77
gum::learning::GraphChangeType::ARC_ADDITION
@ ARC_ADDITION
Definition
graphChange.h:75
gum::learning::GraphChangeType::ARC_TRIANGLE_DELETION1
@ ARC_TRIANGLE_DELETION1
Definition
graphChange.h:78
gum::learning::GraphChangeType::ARC_TRIANGLE_DELETION2
@ ARC_TRIANGLE_DELETION2
Definition
graphChange.h:79
gum
gum is the global namespace for all aGrUM entities
Definition
agrum.h:46
std
STL namespace.
structuralConstraintMandatoryArcs.h
the structural constraint indicating that some arcs shall never be removed or reversed
structuralConstraintMandatoryArcs_inl.h
the structural constraint indicating that some arcs shall never be removed or reversed
aGrUM
3.2.0
© PHW&CG&others - 2022
DoXyGeN 1.18.0