aGrUM
3.3.2
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
forall_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
50
51
// to ease parser in IDEs
52
#include <
agrum/base/multidim/aggregators/forall.h
>
53
54
namespace
gum
{
55
56
namespace
aggregator
{
57
template
< GUM_Numeric GUM_SCALAR >
58
Forall< GUM_SCALAR >::Forall
(
Idx
value
) :
59
MultiDimFoldAggregator
< GUM_SCALAR >(),
_value_
(
value
) {
60
GUM_CONSTRUCTOR(
Forall
);
61
}
62
63
template
< GUM_Numeric GUM_SCALAR >
64
Forall< GUM_SCALAR >::Forall
(
const
Forall< GUM_SCALAR >
& from) :
65
MultiDimFoldAggregator
< GUM_SCALAR >(from) {
66
_value_
= from.
_value_
;
67
GUM_CONS_CPY(
Forall
);
68
}
69
70
template
< GUM_Numeric GUM_SCALAR >
71
Forall< GUM_SCALAR >::~Forall
() {
72
GUM_DESTRUCTOR(
Forall
);
73
}
74
75
template
< GUM_Numeric GUM_SCALAR >
76
Idx
Forall< GUM_SCALAR >::neutralElt_
()
const
{
77
return
(
Idx
)1;
78
}
79
80
template
< GUM_Numeric GUM_SCALAR >
81
Idx
Forall< GUM_SCALAR >::fold_
(
const
DiscreteVariable
& v,
82
Idx
i1,
83
Idx
i2,
84
bool
& stop_iteration)
const
{
85
if
(i1 ==
_value_
) {
86
return
(
Idx
)1;
87
}
else
{
88
stop_iteration =
true
;
89
return
(
Idx
)0;
90
}
91
}
92
93
template
< GUM_Numeric GUM_SCALAR >
94
std::string
Forall< GUM_SCALAR >::aggregatorName
()
const
{
95
return
std::format(
"forall[{}]"
,
_value_
);
96
}
97
98
template
< GUM_Numeric GUM_SCALAR >
99
std::optional< Idx >
Forall< GUM_SCALAR >::value
()
const
{
100
return
_value_
;
101
}
102
103
template
< GUM_Numeric GUM_SCALAR >
104
MultiDimContainer< GUM_SCALAR >
*
Forall< GUM_SCALAR >::newFactory
()
const
{
105
return
new
Forall< GUM_SCALAR >
(
_value_
);
106
}
107
108
}
// namespace aggregator
109
}
// namespace gum
gum::DiscreteVariable
Base class for discrete random variable.
Definition
discreteVariable.h:80
gum::MultiDimContainer< GUM_SCALAR >
gum::aggregator::Forall::aggregatorName
std::string aggregatorName() const override
Adds a variable: the first one is the aggregator, the next ones are its parents.
Definition
forall_tpl.h:94
gum::aggregator::Forall::~Forall
~Forall() override
Definition
forall_tpl.h:71
gum::aggregator::Forall::fold_
Idx fold_(const DiscreteVariable &v, Idx i1, Idx i2, bool &stop_iteration) const override
fold_ is applied on value i1 for variable v. the actual result for precedent applications is i2.
Definition
forall_tpl.h:81
gum::aggregator::Forall::value
std::optional< Idx > value() const override
Returns the scalar parameter of this aggregator, if it has one.
Definition
forall_tpl.h:99
gum::aggregator::Forall::neutralElt_
Idx neutralElt_() const override
neutralElt_() is the result value for the first application of fold_
Definition
forall_tpl.h:76
gum::aggregator::Forall::_value_
Idx _value_
Definition
forall.h:107
gum::aggregator::Forall::newFactory
MultiDimContainer< GUM_SCALAR > * newFactory() const override
This method creates a clone of this object, withouth its content (including variable),...
Definition
forall_tpl.h:104
gum::aggregator::Forall::Forall
Forall(Idx value)
Definition
forall_tpl.h:58
gum::aggregator::MultiDimFoldAggregator< GUM_SCALAR >::MultiDimFoldAggregator
MultiDimFoldAggregator()
Definition
multiDimFoldAggregator_tpl.h:58
forall.h
forall aggregator
gum::Idx
Size Idx
Type for indexes.
Definition
types.h:79
gum::aggregator
Aggregators are functional description of CPTs.
Definition
agrum.h:55
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