aGrUM 3.3.2
a C++ library for (probabilistic) graphical models
multiDimFoldAggregator_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
53
54namespace gum {
55 namespace aggregator {
56
57 template < typename GUM_SCALAR >
62
63 template < typename GUM_SCALAR >
65 const MultiDimFoldAggregator< GUM_SCALAR >& from) : MultiDimAggregator< GUM_SCALAR >(from) {
66 GUM_CONS_CPY(MultiDimFoldAggregator);
67 }
68
69 template < typename GUM_SCALAR >
73
74 template < typename GUM_SCALAR >
76 if (this->nbrDim() == 1) return neutralElt_();
77
78 // is i equal to f(f(f(f...(j_,neutral_elt))))
79 Idx current = neutralElt_();
80
81 bool stop_iteration = false;
83 for (Idx j = 1; j < this->nbrDim(); j++) {
84 current = fold_(this->variable(j), i.val(this->variable(j)), current, stop_iteration);
85
86 if (stop_iteration) break;
87 }
89 return current;
90 }
91
92 } /* namespace aggregator */
93} /* namespace gum */
Class for assigning/browsing values to tuples of discrete variables.
Idx val(Idx i) const
Returns the current value of the variable at position i.
const DiscreteVariable & variable(Idx i) const override
Idx nbrDim() const override
Returns the number of vars in the multidimensional container.
<agrum/base/multidim/aggregators/multiDimAggregator.h>
virtual Idx fold_(const DiscreteVariable &v, Idx i1, Idx i2, bool &stop_iteration) const=0
virtual Idx neutralElt_() const =0
neutralElt_() is the result value for the first application of fold_
Idx buildValue_(const gum::Instantiation &i) const final
computes f(J_1,f(J_2,...,f(J_n,neutralElt_())...)) with fold_() (stops when fold_() sets stop_iterati...
Size Idx
Type for indexes.
Definition types.h:79
MultiDimFoldAggregator: aggregators computed by folding the indices of the parents.
Aggregators are functional description of CPTs.
Definition agrum.h:55
gum is the global namespace for all aGrUM entities
Definition agrum.h:46