aGrUM
3.2.0
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
EMApproximationScheme.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
47
#ifndef GUM_LEARNING_EM_APPROX_SCHEME_H
48
#define GUM_LEARNING_EM_APPROX_SCHEME_H
49
50
#include <algorithm>
51
#include <string>
52
#include <vector>
53
54
#include <
agrum/agrum.h
>
55
56
#include <
agrum/base/core/approximations/approximationScheme.h
>
57
#include <
agrum/base/core/approximations/approximationSchemeListener.h
>
58
59
namespace
gum
{
60
61
namespace
learning
{
62
68
class
GUM_PUBLIC_BN
EMApproximationScheme
:
public
ApproximationScheme
{
69
public
:
74
explicit
EMApproximationScheme
(
bool
verbosity
=
false
);
75
76
// out-of-line, see EMApproximationScheme.cpp
77
~EMApproximationScheme
()
override
;
78
87
void
setEpsilon
(
double
eps)
override
;
88
97
void
setMinDiffEpsilon
(
double
eps);
98
107
void
setMinEpsilonRate
(
double
rate)
override
;
108
};
109
110
}
// namespace learning
111
112
}
// namespace gum
113
114
#ifndef GUM_NO_INLINE
115
# include <
agrum/BN/learning/paramUtils/EMApproximationScheme_inl.h
>
116
#endif
117
118
#endif
// GUM_LEARNING_EM_APPROX_SCHEME_H
EMApproximationScheme_inl.h
agrum.h
approximationSchemeListener.h
gum::ApproximationSchemeListener header file.
approximationScheme.h
This file contains general scheme for iteratively convergent algorithms.
gum::ApproximationScheme::ApproximationScheme
ApproximationScheme(bool verbosity=false)
Definition
approximationScheme.cpp:58
gum::ApproximationScheme::verbosity
bool verbosity() const override
Returns true if verbosity is enabled.
Definition
approximationScheme_inl.h:161
gum::learning::EMApproximationScheme::setMinDiffEpsilon
void setMinDiffEpsilon(double eps)
sets the stopping criterion of EM as being the minimal difference between two consecutive log-likelih...
Definition
EMApproximationScheme_inl.h:59
gum::learning::EMApproximationScheme::EMApproximationScheme
EMApproximationScheme(bool verbosity=false)
initializes the EM parameter learning approximation with the min rate criterion
Definition
EMApproximationScheme.cpp:55
gum::learning::EMApproximationScheme::setMinEpsilonRate
void setMinEpsilonRate(double rate) override
sets the stopping criterion of EM as being the minimal log-likelihood's evolution rate
Definition
EMApproximationScheme_inl.h:61
gum::learning::EMApproximationScheme::setEpsilon
void setEpsilon(double eps) override
sets the stopping criterion of EM as being the minimal difference between two consecutive log-likelih...
Definition
EMApproximationScheme_inl.h:53
gum::learning::EMApproximationScheme::~EMApproximationScheme
~EMApproximationScheme() override
gum::learning
include the inlined functions if necessary
Definition
CSVParser.h:55
gum
gum is the global namespace for all aGrUM entities
Definition
agrum.h:46
aGrUM
3.2.0
© PHW&CG&others - 2022
DoXyGeN 1.18.0