aGrUM 3.3.2
a C++ library for (probabilistic) graphical models
multiDimFoldAggregator.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_MULTI_DIM_FOLD_AGGREGATOR_H
50#define GUM_MULTI_DIM_FOLD_AGGREGATOR_H
51
53
54namespace gum {
55 namespace aggregator {
73 template < typename GUM_ELEMENT >
74 class MultiDimFoldAggregator: public MultiDimAggregator< GUM_ELEMENT > {
75 public:
76 // =======================================================================
78 // =======================================================================
80
83
86
88 ~MultiDimFoldAggregator() override;
89
91
92 protected:
95 Idx buildValue_(const gum::Instantiation& i) const final;
96
98 virtual Idx neutralElt_() const = 0;
99
103 virtual Idx fold_(const DiscreteVariable& v, Idx i1, Idx i2, bool& stop_iteration) const = 0;
104 };
105
106
107#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
108 extern template class GUM_SHARED_PUBLIC MultiDimFoldAggregator< double >;
109#endif
110
111 } /* namespace aggregator */
112} /* namespace gum */
113
115
116#endif /* GUM_MULTI_DIM_FOLD_AGGREGATOR_H */
Base class for discrete random variable.
Class for assigning/browsing values to tuples of discrete variables.
virtual Idx fold_(const DiscreteVariable &v, Idx i1, Idx i2, bool &stop_iteration) const =0
fold_ is applied on value i1 for variable v. the actual result for precedent applications is i2.
virtual Idx neutralElt_() const =0
neutralElt_() is the result value for the first application of fold_
MultiDimFoldAggregator(const MultiDimFoldAggregator< GUM_ELEMENT > &from)
Copy constructor.
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
MultiDimAggregator.
MultiDimFoldAggregator.
Aggregators are functional description of CPTs.
Definition agrum.h:55
template class GUM_SHARED_PUBLIC MultiDimFoldAggregator< double >
gum is the global namespace for all aGrUM entities
Definition agrum.h:46