File: engel_expansion.qbk

package info (click to toggle)
boost1.88 1.88.0-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 576,932 kB
  • sloc: cpp: 4,149,234; xml: 136,789; ansic: 35,092; python: 33,910; asm: 5,698; sh: 4,604; ada: 1,681; makefile: 1,633; pascal: 1,139; perl: 1,124; sql: 640; yacc: 478; ruby: 271; java: 77; lisp: 24; csh: 6
file content (44 lines) | stat: -rw-r--r-- 1,415 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
[/
  Copyright Nick Thompson, 2020
  Distributed under the Boost Software License, Version 1.0.
  (See accompanying file LICENSE_1_0.txt or copy at
  http://www.boost.org/LICENSE_1_0.txt).
]

[section:engel_expansion Engel Expansion]

    #include <boost/math/tools/engel_expansion.hpp>
    namespace boost::math::tools {

    template<typename Real, typename Z = int64_t>
    class engel_expansion {
    public:
        engel_expansion(Real x);
        
        std::vector<Z> const & digits() const;

        template<typename T, typename Z_>
        friend std::ostream& operator<<(std::ostream& out, engel_expansion<T, Z>& engel);
    };
    }


The `engel_expansion` class provided by Boost converts a floating point number into an [@https://en.wikipedia.org/wiki/Engel_expansion Engel series].

Here's a minimal working example:

    using boost::math::constants::e;
    using boost::math::tools::engel_expansion;
    auto engel = engel_expansion(e<double>());
    std::cout << "e ≈ " << engel << "\n";
    // Prints:
    // e ≈ {1, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16}


The digits of an Engel expansion tend to grow exponentially, so the integer template option might need to be utilized.
For example, we can use a wider integer type via

    using boost::multiprecision::checked_int1024_t;
    auto engel = engel_expansion<__float128, checked_int1024_t>(pi<__float128>());

[endsect]