aGrUM
3.3.2
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
or_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
#include <sstream>
52
// to ease parser in IDEs
53
#include <
agrum/base/multidim/aggregators/or.h
>
54
55
namespace
gum
{
56
57
namespace
aggregator
{
58
template
< GUM_Numeric GUM_SCALAR >
59
Or< GUM_SCALAR >::Or
() :
MultiDimFoldAggregator
< GUM_SCALAR >() {
60
this->
decomposable_
=
true
;
61
GUM_CONSTRUCTOR(
Or
);
62
}
63
64
template
< GUM_Numeric GUM_SCALAR >
65
Or< GUM_SCALAR >::Or
(
const
Or< GUM_SCALAR >
& from) :
66
MultiDimFoldAggregator
< GUM_SCALAR >(from) {
67
GUM_CONS_CPY(
Or
);
68
}
69
70
template
< GUM_Numeric GUM_SCALAR >
71
Or< GUM_SCALAR >::~Or
() {
72
GUM_DESTRUCTOR(
Or
);
73
}
74
75
template
< GUM_Numeric GUM_SCALAR >
76
Idx
Or< GUM_SCALAR >::neutralElt_
()
const
{
77
return
(
Idx
)0;
78
}
79
80
template
< GUM_Numeric GUM_SCALAR >
81
Idx
Or< GUM_SCALAR >::fold_
(
const
DiscreteVariable
& v,
82
Idx
i1,
83
Idx
i2,
84
bool
& stop_iteration)
const
{
85
if
(i1 != 1) {
86
return
(
Idx
)0;
87
}
else
{
88
stop_iteration =
true
;
89
return
(
Idx
)1;
90
}
91
}
92
93
template
< GUM_Numeric GUM_SCALAR >
94
std::string
Or< GUM_SCALAR >::aggregatorName
()
const
{
95
return
{
"or"
};
96
}
97
98
template
< GUM_Numeric GUM_SCALAR >
99
MultiDimContainer< GUM_SCALAR >
*
Or< GUM_SCALAR >::newFactory
()
const
{
100
return
new
Or< GUM_SCALAR >
();
101
}
102
103
}
// namespace aggregator
104
}
// namespace gum
gum::DiscreteVariable
Base class for discrete random variable.
Definition
discreteVariable.h:80
gum::MultiDimContainer< GUM_SCALAR >
gum::aggregator::MultiDimFoldAggregator< GUM_SCALAR >::decomposable_
bool decomposable_
Definition
multiDimAggregator.h:218
gum::aggregator::MultiDimFoldAggregator< GUM_SCALAR >::MultiDimFoldAggregator
MultiDimFoldAggregator()
Definition
multiDimFoldAggregator_tpl.h:58
gum::aggregator::Or::neutralElt_
Idx neutralElt_() const override
neutralElt_() is the result value for the first application of fold_
Definition
or_tpl.h:76
gum::aggregator::Or::aggregatorName
std::string aggregatorName() const override
Adds a variable: the first one is the aggregator, the next ones are its parents.
Definition
or_tpl.h:94
gum::aggregator::Or::fold_
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
or_tpl.h:81
gum::aggregator::Or::Or
Or()
Definition
or_tpl.h:59
gum::aggregator::Or::newFactory
MultiDimContainer< GUM_SCALAR > * newFactory() const override
This method creates a clone of this object, withouth its content (including variable),...
Definition
or_tpl.h:99
gum::aggregator::Or::~Or
~Or() override
Definition
or_tpl.h:71
gum::Idx
Size Idx
Type for indexes.
Definition
types.h:79
gum::aggregator
Aggregators are functional description of CPTs.
Definition
agrum.h:55
gum
gum is the global namespace for all aGrUM entities
Definition
agrum.h:46
or.h
or aggregator
aGrUM
3.3.2
© PHW&CG&others - 2022
DoXyGeN 1.18.0