aGrUM
3.3.2
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
doorCriteria_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
#include <
agrum/CM/doorCriteria.h
>
44
45
namespace
gum
{
46
47
48
INLINE std::optional< NodeSet >
DoorCriteria::firstBackdoor
(
const
DAG
& dag,
49
NodeId
X,
50
NodeId
Y,
51
const
NodeSet
& excluded_nodes,
52
std::size_t max_cardinality,
53
bool
only_minimal) {
54
auto
bds
55
=
enumerateBackdoorSets
(dag, X, Y, excluded_nodes, max_cardinality, only_minimal,
true
);
56
if
(bds.empty()) {
return
std::nullopt; }
57
return
bds.front();
58
}
59
60
INLINE std::optional< NodeSet >
DoorCriteria::firstFrontdoor
(
const
DAG
& dag,
61
NodeId
X,
62
NodeId
Y,
63
const
NodeSet
& excluded_nodes,
64
std::size_t max_cardinality,
65
bool
only_minimal) {
66
auto
fds
67
=
enumerateFrontdoorSets
(dag, X, Y, excluded_nodes, max_cardinality, only_minimal,
true
);
68
if
(fds.empty()) {
return
std::nullopt; }
69
return
fds.front();
70
}
71
72
}
// namespace gum
gum::DAG
Base class for dag.
Definition
DAG.h:121
gum::DoorCriteria::firstBackdoor
static std::optional< NodeSet > firstBackdoor(const DAG &dag, NodeId X, NodeId Y, const NodeSet &excluded_nodes=NodeSet(), std::size_t max_cardinality=0, bool only_minimal=true)
Directly return the first backdoor adjustment set if any.
Definition
doorCriteria_inl.h:48
gum::DoorCriteria::enumerateBackdoorSets
static NodeSetVec enumerateBackdoorSets(const DAG &dag, NodeId X, NodeId Y, const NodeSet &excluded_nodes=NodeSet(), std::size_t max_cardinality=0, bool only_minimal=true, bool stopAtFirst=false)
Enumerate valid backdoor adjustment sets.
Definition
doorCriteria.cpp:166
gum::DoorCriteria::enumerateFrontdoorSets
static NodeSetVec enumerateFrontdoorSets(const DAG &dag, NodeId X, NodeId Y, const NodeSet &excluded_nodes=NodeSet(), std::size_t max_cardinality=0, bool only_minimal=true, bool stopAtFirst=false)
Enumerate valid frontdoor adjustment sets.
Definition
doorCriteria.cpp:278
gum::DoorCriteria::firstFrontdoor
static std::optional< NodeSet > firstFrontdoor(const DAG &dag, NodeId X, NodeId Y, const NodeSet &excluded_nodes=NodeSet(), std::size_t max_cardinality=0, bool only_minimal=true)
Directly return the first frontdoor adjustment set if any.
Definition
doorCriteria_inl.h:60
doorCriteria.h
Door criteria (backdoor/frontdoor) utilities for a DAG.
gum::NodeId
Size NodeId
Type for node ids.
Definition
graphElements.h:117
gum::NodeSet
Set< NodeId > NodeSet
Some typdefs and define for shortcuts ...
Definition
graphElements.h:392
gum
gum is the global namespace for all aGrUM entities
Definition
agrum.h:46
aGrUM
3.3.2
© PHW&CG&others - 2022
DoXyGeN 1.18.0