aGrUM 3.3.2
a C++ library for (probabilistic) graphical models
rational.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
48#ifndef GUM_RATIONAL_H
49#define GUM_RATIONAL_H
50
51#include <iomanip>
52#include <iostream>
53#include <sstream>
54#include <stdlib.h>
55#include <vector>
56
57#include <agrum/agrum.h>
58
60
61// 64 bits for windows (long is 32 bits)
62#ifdef _MSC_VER
63typedef __int64 int64_t;
64typedef unsigned __int64 uint64_t;
65#else
66# include <stdint.h>
67#endif
68
69namespace gum {
70
80 template < GUM_Numeric GUM_SCALAR >
81 class Rational {
82 public:
83 // ========================================================================
85 // ========================================================================
87
105 static void farey(int64_t& numerator,
106 int64_t& denominator,
107 const GUM_SCALAR& number,
108 const int64_t& den_max = 1000000L,
109 const GUM_SCALAR& zero
110 = static_cast< GUM_SCALAR >(config().epsilonStandard()));
111
133 static void continuedFracFirst(int64_t& numerator,
134 int64_t& denominator,
135 const GUM_SCALAR& number,
136 const double& zero = config().epsilonStandard());
137
154 static void continuedFracBest(int64_t& numerator,
155 int64_t& denominator,
156 const GUM_SCALAR& number,
157 const int64_t& den_max = 1000000);
158
160 };
161
162} // namespace gum
163
164
165#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
166extern template class GUM_SHARED_PUBLIC gum::Rational< double >;
167extern template class GUM_SHARED_PUBLIC gum::Rational< long double >;
168#endif
169
170
171// Always include template implementation in header file
173
174#endif // GUM_RATIONAL_H
Class template used to approximate decimal numbers by rationals.
Definition rational.h:81
static void continuedFracBest(int64_t &numerator, int64_t &denominator, const GUM_SCALAR &number, const int64_t &den_max=1000000)
Find the best rational approximation.
static void farey(int64_t &numerator, int64_t &denominator, const GUM_SCALAR &number, const int64_t &den_max=1000000L, const GUM_SCALAR &zero=static_cast< GUM_SCALAR >(config().epsilonStandard()))
Find the rational close enough to a given ( decimal ) number in [-1,1] and whose denominator is not h...
static void continuedFracFirst(int64_t &numerator, int64_t &denominator, const GUM_SCALAR &number, const double &zero=config().epsilonStandard())
Find the first best rational approximation.
Useful macros for maths.
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
Configuration & config()
A short name for Configuration::instance() : gum::config().epsilonStandard(). It is not inline so tha...
Class template used to approximate decimal numbers by rationals.