aGrUM 2.3.2
a C++ library for (probabilistic) graphical models
essentialGraph_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-2025 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-2025 *
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#pragma once
41
42
49
50// to ease parsing by IDE
52
53namespace gum {
54
55 INLINE PDAG EssentialGraph::pdag() const { return _pdag_; }
56
57 INLINE const NodeSet& EssentialGraph::parents(NodeId id) const { return _pdag_.parents(id); }
58
59 INLINE const NodeSet& EssentialGraph::children(NodeId id) const { return _pdag_.children(id); }
60
61 INLINE NodeSet EssentialGraph::parents(const NodeSet& ids) const { return _pdag_.parents(ids); }
62
63 INLINE NodeSet EssentialGraph::children(const NodeSet& ids) const { return _pdag_.children(ids); }
64
65 INLINE const NodeSet& EssentialGraph::neighbours(NodeId id) const {
66 return _pdag_.neighbours(id);
67 }
68
69 INLINE Size EssentialGraph::sizeArcs() const { return _pdag_.sizeArcs(); }
70
71 INLINE const ArcSet& EssentialGraph::arcs() const { return _pdag_.arcs(); }
72
73 INLINE Size EssentialGraph::sizeEdges() const { return _pdag_.sizeEdges(); }
74
75 INLINE const EdgeSet& EssentialGraph::edges() const { return _pdag_.edges(); }
76
77 INLINE Size EssentialGraph::sizeNodes() const { return _pdag_.sizeNodes(); }
78
79 INLINE Size EssentialGraph::size() const { return _pdag_.size(); }
80
81 INLINE const NodeGraphPart& EssentialGraph::nodes() const { return _pdag_.nodes(); }
82
83 INLINE NodeId EssentialGraph::idFromName(const std::string& name) const {
84 return _dagmodel_->idFromName(name);
85 };
86
87 INLINE const std::string& EssentialGraph::nameFromId(NodeId node) const {
88 return _dagmodel_->variable(node).name();
89 };
90} // namespace gum
const NodeSet & neighbours(NodeId id) const
wrapping MixedGraph::parents(id)
const std::string & nameFromId(NodeId node) const
wrappping .name()
Size sizeEdges() const
wrapping MixedGraph::sizeEdges()
NodeId idFromName(const std::string &name) const
wrappping DAGModel::idFromName()
const NodeSet & children(NodeId id) const
wrapping MixedGraph::parents(id)
Size sizeArcs() const
wrapping MixedGraph::sizeArcs()
const ArcSet & arcs() const
wrapping MixedGraph::arcs()
const DAGmodel * _dagmodel_
const NodeSet & parents(NodeId id) const
wrapping MixedGraph::parents(id)
const NodeGraphPart & nodes() const
wrapping MixedGraph::nodes()
Size size() const
wrapping MixedGraph::size()
const EdgeSet & edges() const
wrapping MixedGraph::edges()
Size sizeNodes() const
wrapping MixedGraph::sizeNodes()
Class for node sets in graph.
Base class for partially directed acyclic graphs.
Definition PDAG.h:130
Class building the essential Graph from a DAGmodel.
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition types.h:74
Set< Edge > EdgeSet
Some typdefs and define for shortcuts ...
Size NodeId
Type for node ids.
Set< Arc > ArcSet
Some typdefs and define for shortcuts ...
Set< NodeId > NodeSet
Some typdefs and define for shortcuts ...
gum is the global namespace for all aGrUM entities
Definition agrum.h:46