aGrUM
3.3.2
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
math_utils.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
#ifndef GUM_MATH_H
49
#define GUM_MATH_H
50
51
#include <cmath>
52
#include <limits>
53
54
#include <
agrum/base/core/configuration/configuration.h
>
55
56
#ifndef M_LOG2E
57
# define M_LOG2E 1.4426950408889634074
/* log_2 e */
58
#endif
59
60
#ifndef M_PI
61
# define M_PI 3.14159265358979323846
62
#endif
63
64
#ifndef M_LN2
65
# define M_LN2 0.69314718055994530942
/* log_e 2 */
66
#endif
67
68
#ifndef GUM_LOG_SQRT_2PI
// std::log ( std::sqrt ( 2pi ) )
69
# define GUM_LOG_SQRT_2PI .91893853320467274177
70
#endif
71
72
#define GUM_LOG2_OR_0(x) ((x == 0.0) ? 0.0 : std::log2((x)))
73
74
// redefined due to a strange bug in visual c++
75
namespace
gum
{
77
template
<
typename
T >
78
bool
isCloseToZero
(T x, T tol =
static_cast<
T
>
(
config
().epsilonFine()));
79
81
template
<
typename
T >
82
bool
isCloseToOne
(T x, T tol =
static_cast<
T
>
(
config
().epsilonFine()));
83
84
template
<
typename
T >
85
bool
isfinite
(T arg);
86
}
// namespace gum
87
88
#include <
agrum/base/core/math/math_utils_tpl.h
>
89
90
#endif
/* GUM_MATH_H */
configuration.h
Typed, documented, sectioned configuration singleton read from an .ini content.
math_utils_tpl.h
gum
gum is the global namespace for all aGrUM entities
Definition
agrum.h:46
gum::isfinite
bool isfinite(T arg)
Definition
math_utils_tpl.h:57
gum::config
Configuration & config()
A short name for Configuration::instance() : gum::config().epsilonStandard(). It is not inline so tha...
Definition
configuration.cpp:888
gum::isCloseToOne
bool isCloseToOne(T x, T tol=static_cast< T >(config().epsilonFine()))
Is |x - 1| <= tol ? By default, tol is the key core.epsilonFine of the configuration.
Definition
math_utils_tpl.h:52
gum::isCloseToZero
bool isCloseToZero(T x, T tol=static_cast< T >(config().epsilonFine()))
Is |x| <= tol ? By default, tol is the key core.epsilonFine of the configuration.
Definition
math_utils_tpl.h:47
aGrUM
3.3.2
© PHW&CG&others - 2022
DoXyGeN 1.18.0