aGrUM
3.3.2
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
amplitude_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
#include <vector>
52
53
// to ease parser in IDEs
54
#include <
agrum/base/multidim/aggregators/amplitude.h
>
55
#include <
agrum/base/multidim/aggregators/multiDimAggregator.h
>
56
57
namespace
gum
{
58
59
namespace
aggregator
{
60
template
< GUM_Numeric GUM_SCALAR >
61
Amplitude< GUM_SCALAR >::Amplitude
() :
MultiDimValueAggregator
< GUM_SCALAR >() {
62
GUM_CONSTRUCTOR(
Amplitude
);
63
}
64
65
template
< GUM_Numeric GUM_SCALAR >
66
Amplitude< GUM_SCALAR >::Amplitude
(
const
Amplitude< GUM_SCALAR >
& from) :
67
MultiDimValueAggregator
< GUM_SCALAR >(from) {
68
GUM_CONS_CPY(
Amplitude
);
69
}
70
71
template
< GUM_Numeric GUM_SCALAR >
72
Amplitude< GUM_SCALAR >::~Amplitude
() {
73
GUM_DESTRUCTOR(
Amplitude
);
74
}
75
76
template
< GUM_Numeric GUM_SCALAR >
77
std::string
Amplitude< GUM_SCALAR >::aggregatorName
()
const
{
78
return
"amplitude"
;
79
}
80
81
template
< GUM_Numeric GUM_SCALAR >
82
MultiDimContainer< GUM_SCALAR >
*
Amplitude< GUM_SCALAR >::newFactory
()
const
{
83
return
new
Amplitude< GUM_SCALAR >
();
84
}
85
86
template
< GUM_Numeric GUM_SCALAR >
87
Idx
Amplitude< GUM_SCALAR >::buildValue_
(
const
gum::Instantiation
& i)
const
{
88
if
(this->
nbrDim
() < 2)
return
this->
valueToIndex_
(0.0);
89
double
min = this->
parentValue_
(i, 1);
90
double
max = min;
91
for
(
Idx
j = 2; j < this->
nbrDim
(); j++) {
92
const
double
v = this->
parentValue_
(i, j);
93
if
(v < min) min = v;
94
if
(v > max) max = v;
95
}
96
return
this->
valueToIndex_
(max - min);
97
}
98
99
template
< GUM_Numeric GUM_SCALAR >
100
void
Amplitude< GUM_SCALAR >::checkVariable_
(
const
DiscreteVariable
& v)
const
{
101
this->
checkNumericalVariable_
(v);
102
}
103
104
}
// namespace aggregator
105
}
// namespace gum
amplitude.h
amplitude aggregator
gum::DiscreteVariable
Base class for discrete random variable.
Definition
discreteVariable.h:80
gum::Instantiation
Class for assigning/browsing values to tuples of discrete variables.
Definition
instantiation.h:102
gum::MultiDimContainer< GUM_SCALAR >
gum::aggregator::MultiDimValueAggregator< GUM_SCALAR >::nbrDim
Idx nbrDim() const override
Definition
multiDimImplementation_tpl.h:182
gum::aggregator::Amplitude::Amplitude
Amplitude()
Definition
amplitude_tpl.h:61
gum::aggregator::Amplitude::aggregatorName
std::string aggregatorName() const override
Adds a variable: the first one is the aggregator, the next ones are its parents.
Definition
amplitude_tpl.h:77
gum::aggregator::Amplitude::checkVariable_
void checkVariable_(const DiscreteVariable &v) const override
Definition
amplitude_tpl.h:100
gum::aggregator::Amplitude::~Amplitude
~Amplitude() override
Definition
amplitude_tpl.h:72
gum::aggregator::Amplitude::buildValue_
Idx buildValue_(const gum::Instantiation &i) const override
computed on the values of the parents (see MultiDimValueAggregator::valueToIndex_())
Definition
amplitude_tpl.h:87
gum::aggregator::Amplitude::newFactory
MultiDimContainer< GUM_SCALAR > * newFactory() const override
This method creates a clone of this object, withouth its content (including variable),...
Definition
amplitude_tpl.h:82
gum::aggregator::MultiDimValueAggregator< GUM_SCALAR >::parentValue_
double parentValue_(const gum::Instantiation &i, Idx j) const
Definition
multiDimValueAggregator_tpl.h:100
gum::aggregator::MultiDimValueAggregator< GUM_SCALAR >::valueToIndex_
Idx valueToIndex_(double value) const
Definition
multiDimValueAggregator_tpl.h:109
gum::aggregator::MultiDimValueAggregator< GUM_SCALAR >::checkNumericalVariable_
void checkNumericalVariable_(const DiscreteVariable &v) const
Definition
multiDimValueAggregator_tpl.h:79
gum::aggregator::MultiDimValueAggregator< GUM_SCALAR >::MultiDimValueAggregator
MultiDimValueAggregator()
Definition
multiDimValueAggregator_tpl.h:61
gum::Idx
Size Idx
Type for indexes.
Definition
types.h:79
multiDimAggregator.h
MultiDimAggregator.
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