aGrUM
3.2.0
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
structuralConstraintIndegree.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/structuralConstraintIndegree.h
>
50
52
#ifdef GUM_NO_INLINE
53
# include <
agrum/BN/learning/constraints/structuralConstraintIndegree_inl.h
>
54
#endif
/* GUM_NO_INLINE */
55
56
namespace
gum
{
57
58
namespace
learning
{
59
61
StructuralConstraintIndegree::StructuralConstraintIndegree
() {
62
GUM_CONSTRUCTOR(
StructuralConstraintIndegree
);
63
}
64
66
StructuralConstraintIndegree::StructuralConstraintIndegree
(
Size
nb_nodes,
Size
max_indegree) :
67
StructuralConstraintDiGraph
(nb_nodes),
_Indegree_max_indegree_
(max_indegree) {
68
for
(
NodeId
i = 0; i < nb_nodes; ++i) {
69
_Indegree_max_parents_
.insert(i, max_indegree);
70
}
71
GUM_CONSTRUCTOR(
StructuralConstraintIndegree
);
72
}
73
75
StructuralConstraintIndegree::StructuralConstraintIndegree
(
const
DiGraph
&
graph
,
76
Size
max_indegree) :
77
StructuralConstraintDiGraph
(
graph
),
_Indegree_max_indegree_
(max_indegree) {
78
for
(
const
auto
id
:
graph
) {
79
_Indegree_max_parents_
.insert(
id
, max_indegree);
80
}
81
GUM_CONSTRUCTOR(
StructuralConstraintIndegree
);
82
}
83
85
StructuralConstraintIndegree::StructuralConstraintIndegree
(
86
const
StructuralConstraintIndegree
& from) :
87
StructuralConstraintDiGraph
(from),
_Indegree_max_parents_
(from.
_Indegree_max_parents_
),
88
_Indegree_max_indegree_
(from.
_Indegree_max_indegree_
) {
89
GUM_CONS_CPY(
StructuralConstraintIndegree
);
90
}
91
93
StructuralConstraintIndegree::StructuralConstraintIndegree
(
94
StructuralConstraintIndegree
&& from) :
95
StructuralConstraintDiGraph
(
std
::move(from)),
96
_Indegree_max_parents_
(
std
::move(from.
_Indegree_max_parents_
)),
97
_Indegree_max_indegree_
(
std
::move(from.
_Indegree_max_indegree_
)) {
98
GUM_CONS_MOV(
StructuralConstraintIndegree
);
99
}
100
102
StructuralConstraintIndegree::~StructuralConstraintIndegree
() {
103
GUM_DESTRUCTOR(
StructuralConstraintIndegree
);
104
}
105
107
StructuralConstraintIndegree
&
108
StructuralConstraintIndegree::operator=
(
const
StructuralConstraintIndegree
& from) {
109
if
(
this
!= &from) {
110
StructuralConstraintDiGraph::operator=
(from);
111
_Indegree_max_parents_
= from.
_Indegree_max_parents_
;
112
_Indegree_max_indegree_
= from.
_Indegree_max_indegree_
;
113
}
114
115
return
*
this
;
116
}
117
119
StructuralConstraintIndegree
&
120
StructuralConstraintIndegree::operator=
(
StructuralConstraintIndegree
&& from) {
121
if
(
this
!= &from) {
122
StructuralConstraintDiGraph::operator=
(std::move(from));
123
_Indegree_max_parents_
= std::move(from._Indegree_max_parents_);
124
_Indegree_max_indegree_
= std::move(from._Indegree_max_indegree_);
125
}
126
127
return
*
this
;
128
}
129
130
bool
StructuralConstraintIndegree::checkModificationAlone
(
const
GraphChange
& change)
const
{
131
switch
(change.
type
()) {
132
case
GraphChangeType::ARC_ADDITION
:
133
return
checkArcAdditionAlone
(change.
node1
(), change.
node2
());
134
135
case
GraphChangeType::ARC_DELETION
:
136
return
checkArcDeletionAlone
(change.
node1
(), change.
node2
());
137
138
case
GraphChangeType::ARC_REVERSAL
:
139
return
checkArcReversalAlone
(change.
node1
(), change.
node2
());
140
141
case
GraphChangeType::ARC_TRIANGLE_DELETION1
:
142
return
checkArcTriangleDeletion1Alone
(change.
node1
(), change.
node2
(), change.
node3
());
143
144
case
GraphChangeType::ARC_TRIANGLE_DELETION2
:
145
return
checkArcTriangleDeletion2Alone
(change.
node1
(), change.
node2
(), change.
node3
());
146
147
default :
148
GUM_ERROR
(
OperationNotAllowed
,
149
"Graph change operation "
150
<< change.
typeAsString
()
151
<<
" is not supported by the Indegree structural constraint"
);
152
}
153
}
154
}
/* namespace learning */
155
156
}
/* 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::StructuralConstraintDiGraph
The base class for structural constraints used by learning algorithms that learn a directed graph str...
Definition
structuralConstraintDiGraph.h:68
gum::learning::StructuralConstraintDiGraph::operator=
StructuralConstraintDiGraph & operator=(const StructuralConstraintDiGraph &from)
copy operator
Definition
structuralConstraintDiGraph.cpp:96
gum::learning::StructuralConstraintIndegree
the class for structural constraints limiting the number of parents of nodes in a directed graph
Definition
structuralConstraintIndegree.h:67
gum::learning::StructuralConstraintIndegree::_Indegree_max_indegree_
Size _Indegree_max_indegree_
a default max indegree to assign for nodes without specified indegree
Definition
structuralConstraintIndegree.h:266
gum::learning::StructuralConstraintIndegree::checkArcTriangleDeletion1Alone
bool checkArcTriangleDeletion1Alone(NodeId node1, NodeId node2, NodeId node3) const
checks whether the constraints enable to apply an ArcTriangleDeletion1
gum::learning::StructuralConstraintIndegree::checkModificationAlone
bool checkModificationAlone(const ArcAddition &change) const
checks whether the constraints enable to add an arc
gum::learning::StructuralConstraintIndegree::operator=
StructuralConstraintIndegree & operator=(const StructuralConstraintIndegree &from)
copy operator
Definition
structuralConstraintIndegree.cpp:108
gum::learning::StructuralConstraintIndegree::checkArcDeletionAlone
bool checkArcDeletionAlone(NodeId x, NodeId y) const
checks whether the constraints enable to remove arc (x,y)
gum::learning::StructuralConstraintIndegree::StructuralConstraintIndegree
StructuralConstraintIndegree()
default constructor
Definition
structuralConstraintIndegree.cpp:61
gum::learning::StructuralConstraintIndegree::checkArcReversalAlone
bool checkArcReversalAlone(NodeId x, NodeId y) const
checks whether the constraints enable to reverse arc (x,y)
gum::learning::StructuralConstraintIndegree::_Indegree_max_parents_
NodeProperty< Size > _Indegree_max_parents_
the max number of parents per node
Definition
structuralConstraintIndegree.h:263
gum::learning::StructuralConstraintIndegree::checkArcAdditionAlone
bool checkArcAdditionAlone(NodeId x, NodeId y) const
checks whether the constraints enable to add arc (x,y)
gum::learning::StructuralConstraintIndegree::~StructuralConstraintIndegree
~StructuralConstraintIndegree() override
destructor
Definition
structuralConstraintIndegree.cpp:102
gum::learning::StructuralConstraintIndegree::checkArcTriangleDeletion2Alone
bool checkArcTriangleDeletion2Alone(NodeId node1, NodeId node2, NodeId node3) const
checks whether the constraints enable to apply an ArcTriangleDeletion2
GUM_ERROR
#define GUM_ERROR(type, msg)
Definition
exceptions.h:76
gum::Size
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition
types.h:74
gum::NodeId
Size NodeId
Type for node ids.
Definition
graphElements.h:117
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.
structuralConstraintIndegree.h
the class for structural constraints limiting the number of parents of nodes in a directed graph
structuralConstraintIndegree_inl.h
the class for structural constraints limiting the number of parents of nodes in a directed graph
aGrUM
3.2.0
© PHW&CG&others - 2022
DoXyGeN 1.18.0