aGrUM
3.3.2
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
EMApproximationScheme_inl.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
#include <
agrum/BN/learning/paramUtils/EMApproximationScheme.h
>
44
45
namespace
gum
{
46
47
namespace
learning
{
48
49
50
// Constructor and destructor are defined out-of-line in
51
// EMApproximationScheme.cpp on purpose -- see the comment there.
52
53
INLINE
void
EMApproximationScheme::setEpsilon
(
double
eps) {
54
if
(eps <= 0)
GUM_ERROR
(
OutOfBounds
,
"EM's min diff epsilon value must be strictly positive"
)
55
ApproximationScheme::setEpsilon
(eps);
56
ApproximationScheme::disableMinEpsilonRate
();
57
}
58
59
INLINE
void
EMApproximationScheme::setMinDiffEpsilon
(
double
eps) {
setEpsilon
(eps); }
60
61
INLINE
void
EMApproximationScheme::setMinEpsilonRate
(
double
rate) {
62
if
(rate <= 0.0)
63
GUM_ERROR
(
OutOfBounds
,
"EM's min log-likelihood evolution rate must be strictly positive"
)
64
ApproximationScheme::setMinEpsilonRate
(rate);
65
ApproximationScheme::disableEpsilon
();
66
}
67
68
}
// namespace learning
69
70
}
// namespace gum
EMApproximationScheme.h
A class for parameterizing EM's parameter learning approximations.
gum::ApproximationScheme::setMinEpsilonRate
void setMinEpsilonRate(double rate) override
Given that we approximate f(t), stopping criterion on d/dt(|f(t+1)-f(t)|).
Definition
approximationScheme_inl.h:85
gum::ApproximationScheme::disableEpsilon
void disableEpsilon() override
Disable stopping criterion on epsilon.
Definition
approximationScheme_inl.h:75
gum::ApproximationScheme::disableMinEpsilonRate
void disableMinEpsilonRate() override
Disable stopping criterion on epsilon rate.
Definition
approximationScheme_inl.h:96
gum::ApproximationScheme::setEpsilon
void setEpsilon(double eps) override
Given that we approximate f(t), stopping criterion on |f(t+1)-f(t)|.
Definition
approximationScheme_inl.h:64
OutOfBounds
Exception : out of bound.
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::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_ERROR
#define GUM_ERROR(type, msg)
Definition
exceptions.h:76
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.3.2
© PHW&CG&others - 2022
DoXyGeN 1.18.0