aGrUM 3.3.2
a C++ library for (probabilistic) graphical models
MarkovBlanket.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
49#ifndef GUM_MARKOVBLANKET_H
50#define GUM_MARKOVBLANKET_H
51
54
55namespace gum {
56
57 namespace dot {
58 class DotOptions;
59 } // namespace dot
60
71 class GUM_PUBLIC_BN MarkovBlanket {
72 public:
73 MarkovBlanket(const DAGmodel& m, NodeId n, int level = 1);
74 MarkovBlanket(const DAGmodel& m, std::string_view name, int level = 1);
75
77
79 DAG dag() const;
80
81 // @return a dot representation of this MarkovBlanket
82 // node of interest is in red
83 // special arcs (not used during the construction of the Markov Blanket) are in
84 // grey
85 std::string toDot() const;
86
87 // @return a dot representation of this MarkovBlanket, with the options given by the caller
88 std::string toDot(const dot::DotOptions& options) const;
89
91 const NodeSet& parents(NodeId id) const;
92
94 const NodeSet& children(NodeId id) const;
95
97 NodeSet parents(const NodeSet& ids) const;
98
100 NodeSet children(const NodeSet& ids) const;
101
103 NodeSet descendants(NodeId id) const;
104
106 NodeSet ancestors(NodeId id) const;
107
109 Size sizeArcs() const;
110
112 const ArcSet& arcs() const;
113
115 Size sizeNodes() const;
116
118 Size size() const;
119
121 const NodeGraphPart& nodes() const;
122
125 bool hasSameStructure(const DAGmodel& other) const;
126
127 private:
132 };
133} // namespace gum
134
135#ifndef GUM_NO_INLINE
137#endif // GU%_NO_INLINE
138
139#endif // GUM_MARKOVBLANKET_H
Class representing probabilistic DAG model.
Inline implementation of the class building the essential Graph from a DAGmodel.
Base class for dag.
Definition DAG.h:121
Virtual base class for PGMs using a DAG.
Definition DAGmodel.h:64
const DAGmodel & _model_
NodeSet descendants(NodeId id) const
wrapping DAG::descendants(id)
MarkovBlanket(const DAGmodel &m, NodeId n, int level=1)
std::string toDot() const
const NodeSet & parents(NodeId id) const
wrapping DAG::parents(id)
bool hasSameStructure(const DAGmodel &other) const
const NodeSet & children(NodeId id) const
wrapping DAG::children(id)
const NodeId _node_
Size sizeNodes() const
wrapping DAG::sizeNodes()
Size sizeArcs() const
wrapping DAG::sizeArcs()
const ArcSet & arcs() const
wrapping DAG::arcs()
NodeSet ancestors(NodeId id) const
wrapping DAG::ancestors(id)
const NodeGraphPart & nodes() const
wrapping DAG::nodes()
Size size() const
wrapping DAG::size()
Class for node sets in graph.
The options given to a toDot(const DotOptions&).
Definition dotOptions.h:110
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition types.h:74
Size NodeId
Type for node ids.
Set< Arc > ArcSet
Some typdefs and define for shortcuts ...
Set< NodeId > NodeSet
Some typdefs and define for shortcuts ...
Generic Markov-blanket algorithm for directed graphs.
gum is the global namespace for all aGrUM entities
Definition agrum.h:46