aGrUM 3.3.2
a C++ library for (probabilistic) graphical models
PDAG.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
47#ifndef GUM_MAG_H
48#define GUM_MAG_H
49
52
53namespace gum {
54
55 namespace dot {
56 class DotOptions;
57 } // namespace dot
58
59 /* =================================================================== */
60 /* === BASE CLASS FOR MANIPULATING PARTIALLY DIRECTED ACYCLIC GRAPHS */
61 /* =================================================================== */
133 /* ====================================================================== */
134 class GUM_SHARED_PUBLIC PDAG: public MixedGraph {
135 public:
136 // ############################################################################
138 // ############################################################################
140
142
149 bool nodes_resize_policy = true,
151 bool arcs_resize_policy = true,
153 bool edges_resize_policy = true);
154
155 explicit PDAG(const UndiGraph& g);
156 explicit PDAG(const DAG& g);
157 explicit PDAG(const MixedGraph& g);
158
160
161 PDAG(const PDAG& g);
162
164 PDAG(PDAG&& g);
165
167 ~PDAG() override;
168
170
171 // ############################################################################
173 // ############################################################################
175
177
178 PDAG& operator=(const PDAG& g);
179
181 PDAG& operator=(PDAG&& g);
182
184
185 // ############################################################################
187 // ############################################################################
189
191
202 void addArc(NodeId tail, NodeId head) final;
204
206
217 void addEdge(NodeId first, NodeId second) final;
219
224 UndiGraph moralGraph() const;
225
232
240 bool hasMixedReallyOrientedPath(NodeId n1, NodeId n2) const;
241
248 bool cSeparation(NodeId X, NodeId Y, const NodeSet& Z) const;
249
256 bool cSeparation(const NodeSet& X, const NodeSet& Y, const NodeSet& Z) const;
257
259 std::string toDot() const override;
260
262 std::string toDot(const dot::DotOptions& options) const override;
263 };
264
265} /* namespace gum */
266
268
269#ifndef GUM_NO_INLINE
271#endif // GU%_NO_INLINE
272
273#endif /* GUM_MAG_H */
Base classes for directed acyclic graphs.
Inline implementation of Base classes for directed acylic graphs.
Base class for dag.
Definition DAG.h:121
MixedGraph(Size nodes_size=HashTableConst::default_size, bool nodes_resize_policy=true, Size arcs_size=HashTableConst::default_size, bool arcs_resize_policy=true, Size edges_size=HashTableConst::default_size, bool edges_resize_policy=true)
default constructor
const NodeGraphPart & nodes() const
return *this as a NodeGraphPart
void addEdge(NodeId first, NodeId second) final
insert a new edge into the partially directed graph
Definition PDAG_inl.h:93
std::string toDot() const override
to friendly display mixed graph in DOT format
Definition PDAG.cpp:130
void addArc(NodeId tail, NodeId head) final
insert a new arc into the directed graph
Definition PDAG_inl.h:75
UndiGraph moralizedAncestralGraph(const NodeSet &nodes) const
build a UndiGraph by moralizing the Ancestral Graph of a set of Nodes
Definition PDAG.cpp:118
PDAG & operator=(const PDAG &g)
copy operator
Definition PDAG_inl.h:57
PDAG(Size nodes_size=HashTableConst::default_size, bool nodes_resize_policy=true, Size arcs_size=HashTableConst::default_size, bool arcs_resize_policy=true, Size edges_size=HashTableConst::default_size, bool edges_resize_policy=true)
default constructor
Definition PDAG.cpp:60
UndiGraph moralGraph() const
build a UndiGraph by moralizing the PDAG
Definition PDAG.cpp:89
bool hasMixedReallyOrientedPath(NodeId n1, NodeId n2) const
returns true if a mixed edge/directed arc path from node1 to node2 in the arc/edge set exists with at...
Definition PDAG.cpp:106
bool cSeparation(NodeId X, NodeId Y, const NodeSet &Z) const
check if node X and node Y are independent given nodes Z (in the sense of c-separation)
Definition PDAG.cpp:122
Base class for undirected graphs.
Definition undiGraph.h:134
The options given to a toDot(const DotOptions&).
Definition dotOptions.h:110
Concept for mixed graphs (both arcs and edges).
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition types.h:74
Size NodeId
Type for node ids.
Set< NodeId > NodeSet
Some typdefs and define for shortcuts ...
Base classes for mixed directed/undirected graphs.
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
static constexpr Size default_size
The default number of slots in hashtables.
Definition hashTable.h:102