aGrUM 3.1.1
a C++ library for (probabilistic) graphical models
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
50
52#ifdef GUM_NO_INLINE
54#endif /* GUM_NO_INLINE */
55
56namespace gum {
57
58 namespace learning {
59
64
68 for (NodeId i = 0; i < nb_nodes; ++i) {
69 _Indegree_max_parents_.insert(i, max_indegree);
70 }
71 GUM_CONSTRUCTOR(StructuralConstraintIndegree);
72 }
73
76 Size max_indegree) :
78 for (const auto id: graph) {
79 _Indegree_max_parents_.insert(id, max_indegree);
80 }
81 GUM_CONSTRUCTOR(StructuralConstraintIndegree);
82 }
83
91
100
105
117
121 if (this != &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
131 switch (change.type()) {
133 return checkArcAdditionAlone(change.node1(), change.node2());
134
136 return checkArcDeletionAlone(change.node1(), change.node2());
137
139 return checkArcReversalAlone(change.node1(), change.node2());
140
142 return checkArcTriangleDeletion1Alone(change.node1(), change.node2(), change.node3());
143
145 return checkArcTriangleDeletion2Alone(change.node1(), change.node2(), change.node3());
146
147 default :
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 */
Base class for all oriented graphs.
Definition diGraph.h:132
Exception : operation not allowed.
std::string typeAsString() const
returns a string corresponding to the type of the change
NodeId node1() const noexcept
returns the first node involved in the modification
GraphChangeType type() const noexcept
returns the type of the operation
NodeId node2() const noexcept
returns the second node involved in the modification
NodeId node3() const
returns the third node involved in the modification (if any)
The base class for structural constraints used by learning algorithms that learn a directed graph str...
StructuralConstraintDiGraph & operator=(const StructuralConstraintDiGraph &from)
copy operator
the class for structural constraints limiting the number of parents of nodes in a directed graph
Size _Indegree_max_indegree_
a default max indegree to assign for nodes without specified indegree
bool checkArcTriangleDeletion1Alone(NodeId node1, NodeId node2, NodeId node3) const
checks whether the constraints enable to apply an ArcTriangleDeletion1
bool checkModificationAlone(const ArcAddition &change) const
checks whether the constraints enable to add an arc
StructuralConstraintIndegree & operator=(const StructuralConstraintIndegree &from)
copy operator
bool checkArcDeletionAlone(NodeId x, NodeId y) const
checks whether the constraints enable to remove arc (x,y)
bool checkArcReversalAlone(NodeId x, NodeId y) const
checks whether the constraints enable to reverse arc (x,y)
NodeProperty< Size > _Indegree_max_parents_
the max number of parents per node
bool checkArcAdditionAlone(NodeId x, NodeId y) const
checks whether the constraints enable to add arc (x,y)
bool checkArcTriangleDeletion2Alone(NodeId node1, NodeId node2, NodeId node3) const
checks whether the constraints enable to apply an ArcTriangleDeletion2
#define GUM_ERROR(type, msg)
Definition exceptions.h:76
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition types.h:74
Size NodeId
Type for node ids.
include the inlined functions if necessary
Definition CSVParser.h:55
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
STL namespace.
the class for structural constraints limiting the number of parents of nodes in a directed graph
the class for structural constraints limiting the number of parents of nodes in a directed graph