aGrUM
3.3.2
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
ITerminalNodePolicy.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
50
#ifndef GUM_MULTI_DIM_FUNCTION_GRAPH_INTERFACE_TERMINAL_NODE_POLICY_H
51
#define GUM_MULTI_DIM_FUNCTION_GRAPH_INTERFACE_TERMINAL_NODE_POLICY_H
52
53
#include <
agrum/base/graphs/parts/nodeGraphPart.h
>
54
55
namespace
gum
{
56
57
// clang-format off
66
template
<
typename
GUM_SCALAR>
67
class
ITerminalNodePolicy
{
68
69
public
:
70
// ============================================================================
72
// ============================================================================
74
76
virtual
void
addTerminalNode
(
const
NodeId
& n,
const
GUM_SCALAR& v ) = 0;
77
79
virtual
void
eraseTerminalNode
(
const
NodeId
& n ) = 0;
80
82
virtual
void
clearAllTerminalNodes
() = 0;
83
85
// ============================================================================
87
// ============================================================================
89
91
virtual
bool
existsTerminalNodeWithId
(
const
NodeId
& n )
const
= 0;
92
94
virtual
bool
existsTerminalNodeWithValue
(
const
GUM_SCALAR& v )
const
= 0;
95
97
// ============================================================================
99
// ============================================================================
101
103
virtual
const
GUM_SCALAR&
terminalNodeValue
(
const
NodeId
& n )
const
= 0;
104
106
virtual
const
NodeId
&
terminalNodeId
(
const
GUM_SCALAR& v )
const
= 0;
107
109
// ============================================================================
111
// ============================================================================
113
115
virtual
void
beginValues
()
const
= 0;
116
118
virtual
bool
hasValue
()
const
= 0;
119
121
virtual
void
nextValue
()
const
= 0;
122
125
virtual
const
GUM_SCALAR&
value
()
const
= 0;
126
129
virtual
const
NodeId
&
id
()
const
= 0;
130
132
};
133
134
}
// End of namespace gum
135
136
#endif
/* GUM_MULTI_DIM_FUNCTION_GRAPH_INTERFACE_TERMINAL_NODE_POLICY_H */
gum::ITerminalNodePolicy
Interface specifying the methods to be implemented by any TerminalNodePolicy.
Definition
ITerminalNodePolicy.h:67
gum::ITerminalNodePolicy::eraseTerminalNode
virtual void eraseTerminalNode(const NodeId &n)=0
Remove node matching given id.
gum::ITerminalNodePolicy::hasValue
virtual bool hasValue() const =0
Indicates if constant safe iterator has reach end of terminal nodes list.
gum::ITerminalNodePolicy::terminalNodeValue
virtual const GUM_SCALAR & terminalNodeValue(const NodeId &n) const =0
Returns the value of the terminal node that has the given id.
gum::ITerminalNodePolicy::beginValues
virtual void beginValues() const =0
Initializes the constant safe iterator on terminal nodes.
gum::ITerminalNodePolicy::addTerminalNode
virtual void addTerminalNode(const NodeId &n, const GUM_SCALAR &v)=0
Insert a new terminal node with given value.
gum::ITerminalNodePolicy::value
virtual const GUM_SCALAR & value() const =0
Returns the value of the current terminal nodes pointed by the constant safe iterator.
gum::ITerminalNodePolicy::clearAllTerminalNodes
virtual void clearAllTerminalNodes()=0
Erase all terminal nodes.
gum::ITerminalNodePolicy::terminalNodeId
virtual const NodeId & terminalNodeId(const GUM_SCALAR &v) const =0
Returns the id of the terminal node that has the given value.
gum::ITerminalNodePolicy::id
virtual const NodeId & id() const =0
Returns the id of the current terminal nodes pointed by the constant safe iterator.
gum::ITerminalNodePolicy::existsTerminalNodeWithId
virtual bool existsTerminalNodeWithId(const NodeId &n) const =0
Returns true if a terminal node matching this id exists.
gum::ITerminalNodePolicy::nextValue
virtual void nextValue() const =0
Increments the constant safe iterator.
gum::ITerminalNodePolicy::existsTerminalNodeWithValue
virtual bool existsTerminalNodeWithValue(const GUM_SCALAR &v) const =0
Returns true if a terminal node matching this value exists.
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
nodeGraphPart.h
Base node set class for graphs.
aGrUM
3.3.2
© PHW&CG&others - 2022
DoXyGeN 1.18.0