aGrUM 3.1.1
a C++ library for (probabilistic) graphical models
structuralConstraintMandatoryArcs_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
51#ifndef DOXYGEN_SHOULD_SKIP_THIS
52
53namespace gum {
54
55 namespace learning {
56
58 INLINE void StructuralConstraintMandatoryArcs::setGraphAlone(const DiGraph& graph) {}
59
62 return true;
63 }
64
67 return !_MandatoryArcs_mandatory_arcs_.exists(Arc(x, y));
68 }
69
72 return !_MandatoryArcs_mandatory_arcs_.exists(Arc(x, y));
73 }
74
76 INLINE bool
78 NodeId node2,
79 NodeId node3) const {
80 return !_MandatoryArcs_mandatory_arcs_.exists(Arc(node2, node1))
81 && !_MandatoryArcs_mandatory_arcs_.exists(Arc(node3, node1));
82 }
83
85 INLINE bool
87 NodeId node2,
88 NodeId node3) const {
89 return !_MandatoryArcs_mandatory_arcs_.exists(Arc(node3, node2));
90 }
91
93 INLINE bool
95 return checkArcAdditionAlone(change.node1(), change.node2());
96 }
97
99 INLINE bool
101 return checkArcDeletionAlone(change.node1(), change.node2());
102 }
103
105 INLINE bool
107 return checkArcReversalAlone(change.node1(), change.node2());
108 }
109
112 const ArcTriangleDeletion1& change) const {
113 return checkArcTriangleDeletion1Alone(change.node1(), change.node2(), change.node3());
114 }
115
118 const ArcTriangleDeletion2& change) const {
119 return checkArcTriangleDeletion2Alone(change.node1(), change.node2(), change.node3());
120 }
121
123
126
129
132
135
137 INLINE void
139
141 INLINE void
143
145
147 INLINE void StructuralConstraintMandatoryArcs::setArcs(const ArcSet& set) {
149 }
150
152 INLINE void StructuralConstraintMandatoryArcs::addArc(const Arc& arc) {
154 }
155
157 INLINE void StructuralConstraintMandatoryArcs::eraseArc(const Arc& arc) {
159 }
160
162 INLINE const ArcSet& StructuralConstraintMandatoryArcs::arcs() const {
164 }
165
166// include all the methods applicable to the whole class hierarchy
167# define GUM_CONSTRAINT_CLASS_NAME StructuralConstraintMandatoryArcs
169# undef GUM_CONSTRAINT_CLASS_NAME
170
171 } /* namespace learning */
172
173} /* namespace gum */
174
175#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...
bool checkArcReversalAlone(NodeId x, NodeId y) const
checks whether the constraints enable to reverse arc (x,y)
bool checkArcDeletionAlone(NodeId x, NodeId y) const
checks whether the constraints enable to remove arc (x,y)
void modifyGraphAlone(const ArcAddition &change)
notify the constraint of a modification of the graph
bool checkModificationAlone(const GraphChange &change) const
checks whether the constraints enable to perform a graph change
void setArcs(const ArcSet &set)
assign a set of forbidden arcs
void eraseArc(const Arc &arc)
remove a forbidden arc
ArcSet _MandatoryArcs_mandatory_arcs_
the MandatoryArcs on which we perform checks
bool checkArcTriangleDeletion1Alone(NodeId node1, NodeId node2, NodeId node3) const
checks whether the constraints enable to apply an ArcTriangleDeletion1
void setGraphAlone(const DiGraph &graph)
sets a new graph from which we will perform checkings
void addArc(const Arc &arc)
assign a new forbidden arc
const ArcSet & arcs() const
returns the set of mandatory arcs
bool checkArcTriangleDeletion2Alone(NodeId node1, NodeId node2, NodeId node3) const
checks whether the constraints enable to apply an ArcTriangleDeletion2
bool checkArcAdditionAlone(NodeId x, NodeId y) const
checks whether the constraints enable to add arc (x,y)
Size NodeId
Type for node ids.
Set< Arc > ArcSet
Some typdefs and define for shortcuts ...
include the inlined functions if necessary
Definition CSVParser.h:55
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
the structural constraint indicating that some arcs shall never be removed or reversed