aGrUM 3.1.1
a C++ library for (probabilistic) graphical models
structuralConstraintDiGraph.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
70
76
82
88
93
97 if (this != &from) { _graph_ = from._graph_; }
98 return *this;
99 }
100
104 if (this != &from) { _graph_ = std::move(from._graph_); }
105 return *this;
106 }
107
109 switch (change.type()) {
111 return checkArcAdditionAlone(change.node1(), change.node2());
112
114 return checkArcDeletionAlone(change.node1(), change.node2());
115
117 return checkArcReversalAlone(change.node1(), change.node2());
118
120 return checkArcTriangleDeletion1Alone(change.node1(), change.node2(), change.node3());
121
123 return checkArcTriangleDeletion2Alone(change.node1(), change.node2(), change.node3());
124
125 default :
127 "Graph change operation "
128 << change.typeAsString()
129 << " is not supported by the DiGraph structural constraint");
130 }
131 }
132
134 switch (change.type()) {
136 modifyGraphAlone(reinterpret_cast< const ArcAddition& >(change));
137 break;
138
140 modifyGraphAlone(reinterpret_cast< const ArcDeletion& >(change));
141 break;
142
144 modifyGraphAlone(reinterpret_cast< const ArcReversal& >(change));
145 break;
146
148 modifyGraphAlone(reinterpret_cast< const ArcTriangleDeletion1& >(change));
149 break;
150
152 modifyGraphAlone(reinterpret_cast< const ArcTriangleDeletion2& >(change));
153 break;
154
155 default :
157 "Graph change operation "
158 << change.typeAsString()
159 << " is not supported by the DiGraph structural constraint")
160 }
161 }
162 } /* namespace learning */
163
164} /* namespace gum */
Base class for all oriented graphs.
Definition diGraph.h:132
Exception : operation not allowed.
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...
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
void modifyGraphAlone(const ArcAddition &change)
notify the constraint of a modification of the graph
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)
bool checkArcTriangleDeletion1Alone(NodeId node1, NodeId node2, NodeId node3) const
checks whether the constraints enable to apply an ArcTriangleDeletion1
bool checkArcTriangleDeletion2Alone(NodeId node1, NodeId node2, NodeId node3) const
checks whether the constraints enable to apply an ArcTriangleDeletion2
void setGraph(Size nb_nodes)
sets a new empty graph from which we will perform checking
DiGraph _graph_
the DiGraph on which we perform checks
bool checkArcAdditionAlone(NodeId x, NodeId y) const
checks whether the constraints enable to add arc (x,y)
bool checkModificationAlone(const GraphChange &change) const
checks whether the constraints enable to perform a graph change
#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
include the inlined functions if necessary
Definition CSVParser.h:55
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
the base class for structural constraints used by learning algorithms that learn a directed graph str...
the base class for structural constraints used by learning algorithms that learn a directed graph str...