aGrUM 3.3.2
a C++ library for (probabilistic) graphical models
sum.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
48
49#ifndef GUM_SUM_AGGREGATOR_H
50#define GUM_SUM_AGGREGATOR_H
51
53
54namespace gum::aggregator {
55 // =========================================================================
56 // === GUM_SUM_AGGREGATOR ===
57 // =========================================================================
58
68 template < GUM_Numeric GUM_SCALAR >
69 class Sum final: public MultiDimValueAggregator< GUM_SCALAR > {
70 public:
71 Sum();
72 Sum(const Sum< GUM_SCALAR >& from);
73 ~Sum() override;
74
92 [[nodiscard]] MultiDimContainer< GUM_SCALAR >* newFactory() const final;
93
94 std::string aggregatorName() const final;
95
96 protected:
98 Idx buildValue_(const gum::Instantiation& i) const final;
99
101 void checkVariable_(const DiscreteVariable& v) const final;
102 };
103
104
105#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
106 extern template class GUM_SHARED_PUBLIC Sum< double >;
107#endif
108
109
110} // namespace gum::aggregator
111
113
114#endif // GUM_SUM_AGGREGATOR_H
Base class for discrete random variable.
Class for assigning/browsing values to tuples of discrete variables.
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
Size Idx
Type for indexes.
Definition types.h:79
MultiDimValueAggregator: aggregators computed on the values of the parents.
Aggregators are functional description of CPTs.
Definition agrum.h:55
template class GUM_SHARED_PUBLIC Sum< double >
Definition sum.cpp:53
sum aggregator