aGrUM 3.1.1
a C++ library for (probabilistic) graphical models
structuralConstraintNoParentNodes_inl.h
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#pragma once
42
43
45
52#ifndef DOXYGEN_SHOULD_SKIP_THIS
53
54
55namespace gum::learning {
56
58 INLINE void StructuralConstraintNoParentNodes::setGraphAlone(const DiGraph& graph) {}
59
62 return !_noParentNodes_.exists(y);
63 }
64
67 return true;
68 }
69
72 return !_noParentNodes_.exists(x);
73 }
74
77 NodeId y,
78 NodeId z) const {
79 return !_noParentNodes_.exists(x);
80 }
81
84 NodeId y,
85 NodeId z) const {
86 return !_noParentNodes_.exists(y);
87 }
88
90 INLINE bool
92 return checkArcAdditionAlone(change.node1(), change.node2());
93 }
94
96 INLINE bool
98 return checkArcDeletionAlone(change.node1(), change.node2());
99 }
100
102 INLINE bool
104 return checkArcReversalAlone(change.node1(), change.node2());
105 }
106
109 const ArcTriangleDeletion1& change) const {
110 return checkArcTriangleDeletion1Alone(change.node1(), change.node2(), change.node3());
111 }
112
115 const ArcTriangleDeletion2& change) const {
116 return checkArcTriangleDeletion2Alone(change.node1(), change.node2(), change.node3());
117 }
118
120
123
126
129
131 INLINE void
133
135 INLINE void
137
140
142 INLINE bool
144 switch (change.type()) {
145 case GraphChangeType::ARC_ADDITION : return _noParentNodes_.exists(change.node2());
146
147 case GraphChangeType::ARC_DELETION : return false;
148
149 case GraphChangeType::ARC_REVERSAL : return _noParentNodes_.exists(change.node1());
150
151 case GraphChangeType::ARC_TRIANGLE_DELETION1 : return _noParentNodes_.exists(change.node1());
152
153 case GraphChangeType::ARC_TRIANGLE_DELETION2 : return _noParentNodes_.exists(change.node2());
154
155 default :
156 GUM_ERROR(OperationNotAllowed,
157 "edge modifications are not supported "
158 "by the No-Parent Nodes structural constraint");
159 }
160 }
161
164 _noParentNodes_ = set;
165 }
166
169 _noParentNodes_.insert(node);
170 }
171
174 _noParentNodes_.erase(node);
175 }
176
179
180// include all the methods applicable to the whole class hierarchy
181# define GUM_CONSTRAINT_CLASS_NAME StructuralConstraintNoParentNodes
183# undef GUM_CONSTRAINT_CLASS_NAME
184
185} // namespace gum::learning
186
187
188#endif /* DOXYGEN_SHOULD_SKIP_THIS */
The class for notifying learning algorithms of new arc additions.
The class for notifying learning algorithms of arc removals.
The class for notifying learning algorithms of arc reversals.
The graph change substituting a triangle node1->node2->node3 + node1->node3 into v-structure node2->n...
The graph change substituting a triangle node1->node2->node3 + node1->node3 into v-structure node1->n...
NodeSet _noParentNodes_
the ForbiddenArcs on which we perform checks
bool checkArcDeletionAlone(NodeId x, NodeId y) const
checks whether the constraints enable to remove arc (x,y)
bool checkArcTriangleDeletion2Alone(NodeId node1, NodeId node2, NodeId node3) const
checks whether the constraints enable to apply an ArcTriangleDeletion2
bool checkModificationAlone(const GraphChange &change) const
checks whether the constraints enable to perform a graph change
void modifyGraphAlone(const ArcAddition &change)
notify the constraint of a modification of the graph
const NodeSet & nodes() const
returns the set of nodes without parent
void setNodes(const NodeSet &set)
assign a set of nodes without parent
bool isAlwaysInvalidAlone(const GraphChange &change) const
indicates whether a change will always violate the constraint
void addNode(NodeId node)
assign a new node without parent
void setGraphAlone(const DiGraph &graph)
sets a new graph from which we will perform checkings
bool checkArcTriangleDeletion1Alone(NodeId node1, NodeId node2, NodeId node3) const
checks whether the constraints enable triangle deletion1
bool checkArcReversalAlone(NodeId x, NodeId y) const
checks whether the constraints enable to reverse arc (x,y)
void eraseNode(NodeId node)
remove a node without parent
bool checkArcAdditionAlone(NodeId x, NodeId y) const
checks whether the constraints enable to add arc (x,y)
#define GUM_ERROR(type, msg)
Definition exceptions.h:76
Size NodeId
Type for node ids.
Set< NodeId > NodeSet
Some typdefs and define for shortcuts ...
include the inlined functions if necessary
Definition CSVParser.h:55
the structural constraint for forbidding parents for some nodes during structure learning