aGrUM 3.3.2
a C++ library for (probabilistic) graphical models
sum_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
52
53namespace gum::aggregator {
54 template < GUM_Numeric GUM_SCALAR >
56 this->decomposable_ = true;
57 GUM_CONSTRUCTOR(Sum);
58 }
59
60 template < GUM_Numeric GUM_SCALAR >
62 MultiDimValueAggregator< GUM_SCALAR >(from) {
63 GUM_CONS_CPY(Sum);
64 }
65
66 template < GUM_Numeric GUM_SCALAR >
68 GUM_DESTRUCTOR(Sum);
69 }
70
71 template < GUM_Numeric GUM_SCALAR >
73 double res = 0.0;
74 for (Idx j = 1; j < this->nbrDim(); j++)
75 res += this->parentValue_(i, j);
76 return this->valueToIndex_(res);
77 }
78
79 template < GUM_Numeric GUM_SCALAR >
83
84 template < GUM_Numeric GUM_SCALAR >
86 return "sum";
87 }
88
89 template < GUM_Numeric GUM_SCALAR >
93
94} // namespace gum::aggregator
Base class for discrete random variable.
Class for assigning/browsing values to tuples of discrete variables.
double parentValue_(const gum::Instantiation &i, Idx j) const
std::string aggregatorName() const final
Adds a variable: the first one is the aggregator, the next ones are its parents.
Definition sum_tpl.h:85
MultiDimContainer< GUM_SCALAR > * newFactory() const final
This method creates a clone of this object, without its content (including variable),...
Definition sum_tpl.h:90
Idx buildValue_(const gum::Instantiation &i) const final
computed on the values of the parents (see MultiDimValueAggregator::valueToIndex_())
Definition sum_tpl.h:72
void checkVariable_(const DiscreteVariable &v) const final
Definition sum_tpl.h:80
~Sum() override
Definition sum_tpl.h:67
Size Idx
Type for indexes.
Definition types.h:79
Aggregators are functional description of CPTs.
Definition agrum.h:55
sum aggregator