aGrUM
3.2.0
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
ExactTerminalNodePolicy_tpl.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/base/multidim/utils/FunctionGraphUtilities/terminalNodePolicies/ExactTerminalNodePolicy.h
>
44
45
namespace
gum
{
46
47
48
template
<
typename
GUM_ELEMENT >
49
void
ExactTerminalNodePolicy< GUM_ELEMENT >::addTerminalNode
(
const
NodeId
& n,
50
const
GUM_ELEMENT& v) {
51
_map_
.insert(n, v);
52
}
53
54
template
<
typename
GUM_ELEMENT >
55
void
ExactTerminalNodePolicy< GUM_ELEMENT >::eraseTerminalNode
(
const
NodeId
& n) {
56
_map_
.eraseFirst(n);
57
}
58
59
template
<
typename
GUM_ELEMENT >
60
void
ExactTerminalNodePolicy< GUM_ELEMENT >::clearAllTerminalNodes
() {
61
_map_
.clear();
62
}
63
64
template
<
typename
GUM_ELEMENT >
65
bool
ExactTerminalNodePolicy< GUM_ELEMENT >::existsTerminalNodeWithId
(
const
NodeId
& n)
const
{
66
return
_map_
.existsFirst(n);
67
}
68
69
template
<
typename
GUM_ELEMENT >
70
bool
ExactTerminalNodePolicy< GUM_ELEMENT >::existsTerminalNodeWithValue
(
71
const
GUM_ELEMENT& v)
const
{
72
return
_map_
.existsSecond(v);
73
}
74
75
template
<
typename
GUM_ELEMENT >
76
const
GUM_ELEMENT&
77
ExactTerminalNodePolicy< GUM_ELEMENT >::terminalNodeValue
(
const
NodeId
& n)
const
{
78
return
_map_
.second(n);
79
}
80
81
template
<
typename
GUM_ELEMENT >
82
const
NodeId
&
ExactTerminalNodePolicy< GUM_ELEMENT >::terminalNodeId
(
const
GUM_ELEMENT& v)
const
{
83
return
_map_
.first(v);
84
}
85
86
template
<
typename
GUM_ELEMENT >
87
void
ExactTerminalNodePolicy< GUM_ELEMENT >::beginValues
()
const
{
88
_mappy_
=
_map_
.beginSafe();
89
}
90
91
template
<
typename
GUM_ELEMENT >
92
bool
ExactTerminalNodePolicy< GUM_ELEMENT >::hasValue
()
const
{
93
return
_mappy_
!=
_map_
.endSafe();
94
}
95
96
template
<
typename
GUM_ELEMENT >
97
void
ExactTerminalNodePolicy< GUM_ELEMENT >::nextValue
()
const
{
98
++
_mappy_
;
99
}
100
101
template
<
typename
GUM_ELEMENT >
102
const
GUM_ELEMENT&
ExactTerminalNodePolicy< GUM_ELEMENT >::value
()
const
{
103
return
_mappy_
.second();
104
}
105
106
template
<
typename
GUM_ELEMENT >
107
const
NodeId
&
ExactTerminalNodePolicy< GUM_ELEMENT >::id
()
const
{
108
return
_mappy_
.first();
109
}
110
111
}
// namespace gum
ExactTerminalNodePolicy.h
Headers of the ExactTerminalNodePolicy.
gum::ExactTerminalNodePolicy::id
const NodeId & id() const override
Returns the id of the current terminal nodes pointed by the constant safe iterator.
Definition
ExactTerminalNodePolicy_tpl.h:107
gum::ExactTerminalNodePolicy::hasValue
bool hasValue() const override
Indicates if constant safe iterator has reach end of terminal nodes list.
Definition
ExactTerminalNodePolicy_tpl.h:92
gum::ExactTerminalNodePolicy::nextValue
void nextValue() const override
Increments the constant safe iterator.
Definition
ExactTerminalNodePolicy_tpl.h:97
gum::ExactTerminalNodePolicy::_mappy_
BijectionIteratorSafe< NodeId, GUM_ELEMENT > _mappy_
Definition
ExactTerminalNodePolicy.h:136
gum::ExactTerminalNodePolicy::terminalNodeId
const NodeId & terminalNodeId(const GUM_ELEMENT &v) const override
Returns the id of the terminal node that has the given value.
Definition
ExactTerminalNodePolicy_tpl.h:82
gum::ExactTerminalNodePolicy::existsTerminalNodeWithId
bool existsTerminalNodeWithId(const NodeId &n) const override
Returns true if a terminal node matching this id exists.
Definition
ExactTerminalNodePolicy_tpl.h:65
gum::ExactTerminalNodePolicy::terminalNodeValue
const GUM_ELEMENT & terminalNodeValue(const NodeId &n) const override
Returns the value of the terminal node that has the given id.
Definition
ExactTerminalNodePolicy_tpl.h:77
gum::ExactTerminalNodePolicy::_map_
Bijection< NodeId, GUM_ELEMENT > _map_
Definition
ExactTerminalNodePolicy.h:135
gum::ExactTerminalNodePolicy::addTerminalNode
void addTerminalNode(const NodeId &n, const GUM_ELEMENT &v) override
Insert a new terminal node with given value.
Definition
ExactTerminalNodePolicy_tpl.h:49
gum::ExactTerminalNodePolicy::clearAllTerminalNodes
void clearAllTerminalNodes() override
Erase all terminal nodes.
Definition
ExactTerminalNodePolicy_tpl.h:60
gum::ExactTerminalNodePolicy::existsTerminalNodeWithValue
bool existsTerminalNodeWithValue(const GUM_ELEMENT &v) const override
Returns true if a terminal node matching this value exists.
Definition
ExactTerminalNodePolicy_tpl.h:70
gum::ExactTerminalNodePolicy::beginValues
void beginValues() const override
Initializes the constant safe iterator on terminal nodes.
Definition
ExactTerminalNodePolicy_tpl.h:87
gum::ExactTerminalNodePolicy::value
const GUM_ELEMENT & value() const override
Returns the value of the current terminal nodes pointed by the constant safe iterator.
Definition
ExactTerminalNodePolicy_tpl.h:102
gum::ExactTerminalNodePolicy::eraseTerminalNode
void eraseTerminalNode(const NodeId &n) override
Remove node matching given id.
Definition
ExactTerminalNodePolicy_tpl.h:55
gum::NodeId
Size NodeId
Type for node ids.
Definition
graphElements.h:117
gum
gum is the global namespace for all aGrUM entities
Definition
agrum.h:46
aGrUM
3.2.0
© PHW&CG&others - 2022
DoXyGeN 1.18.0