aGrUM 3.1.1
a C++ library for (probabilistic) graphical models
max_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
56 namespace aggregator {
57 template < GUM_Numeric GUM_SCALAR >
59 this->decomposable_ = true;
60 GUM_CONSTRUCTOR(Max);
61 }
62
63 template < GUM_Numeric GUM_SCALAR >
64 Max< GUM_SCALAR >::Max(const Max< GUM_SCALAR >& from) : MultiDimAggregator< GUM_SCALAR >(from) {
65 GUM_CONS_CPY(Max);
66 }
67
68 template < GUM_Numeric GUM_SCALAR >
70 GUM_DESTRUCTOR(Max);
71 }
72
73 template < GUM_Numeric GUM_SCALAR >
75 return (Idx)0;
76 }
77
78 template < GUM_Numeric GUM_SCALAR >
80 Idx i1,
81 Idx i2,
82 bool& stop_iteration) const {
83 return (i1 > i2) ? i1 : i2;
84 }
85
86 template < GUM_Numeric GUM_SCALAR >
88 return "max";
89 }
90
91 template < GUM_Numeric GUM_SCALAR >
95
96 } // namespace aggregator
97} // namespace gum
Base class for discrete random variable.
Idx fold_(const DiscreteVariable &v, Idx i1, Idx i2, bool &stop_iteration) const override
fold_ is applied on value i1 for variable v. the actual result for precedent applications is i2.
Definition max_tpl.h:79
std::string aggregatorName() const override
Returns the scalar parameter of this aggregator, if it has one.
Definition max_tpl.h:87
MultiDimContainer< GUM_SCALAR > * newFactory() const override
This method creates a clone of this object, withouth its content (including variable),...
Definition max_tpl.h:92
Idx neutralElt_() const override
neutralElt_() is the result value for the first application of fold_
Definition max_tpl.h:74
~Max() override
Definition max_tpl.h:69
Size Idx
Type for indexes.
Definition types.h:79
max aggregator
Aggregators are functional description of CPTs.
Definition agrum.h:55
gum is the global namespace for all aGrUM entities
Definition agrum.h:46