1[/
2  Copyright 2011 - 2020 John Maddock.
3  Copyright 2013 - 2019 Paul A. Bristow.
4  Copyright 2013 Christopher Kormanyos.
5
6  Distributed under the Boost Software License, Version 1.0.
7  (See accompanying file LICENSE_1_0.txt or copy at
8  http://www.boost.org/LICENSE_1_0.txt).
9]
10
11[library Boost.Multiprecision
12    [quickbook 1.7]
13    [copyright 2002-2020 John Maddock and Christopher Kormanyos]
14    [purpose Multiprecision Number library]
15    [license
16         Distributed under the Boost Software License, Version 1.0.
17         (See accompanying file LICENSE_1_0.txt or copy at
18         [@http://www.boost.org/LICENSE_1_0.txt])
19    ]
20    [authors [Maddock, John], [Kormanyos, Christopher]]
21    [/last-revision $Date: 2011-07-08 18:51:46 +0100 (Fri, 08 Jul 2011) $]
22]
23
24[import html4_symbols.qbk] [/Ideally this should be the same as Boost.Math I:\boost\libs\math\doc]
25
26[import ../example/gmp_snips.cpp]
27[import ../example/mpfr_snips.cpp]
28[import ../example/mpfi_snips.cpp]
29[import ../example/float128_snips.cpp]
30[import ../example/cpp_dec_float_snips.cpp]
31[import ../example/cpp_bin_float_snips.cpp]
32[/import ../example/big_seventh.cpp]
33
34[import ../example/cpp_int_import_export.cpp]
35[import ../example/cpp_bin_float_import_export.cpp]
36[import ../example/tommath_snips.cpp]
37[import ../example/cpp_int_snips.cpp]
38[import ../example/random_snips.cpp]
39[import ../example/safe_prime.cpp]
40[import ../example/mixed_integer_arithmetic.cpp]
41[import ../example/logged_adaptor.cpp]
42[import ../example/numeric_limits_snips.cpp]
43[import ../example/hashing_examples.cpp]
44[import ../example/cpp_complex_examples.cpp]
45[import ../example/mpc_examples.cpp]
46[import ../example/complex128_examples.cpp]
47[import ../example/eigen_example.cpp]
48[import ../example/mpfr_precision.cpp]
49[import ../example/constexpr_float_arithmetic_examples.cpp]
50[import ../test/constexpr_test_cpp_int_5.cpp]
51[import ../test/constexpr_test_cpp_int_7.cpp]
52
53[/External links as templates (see also some defs below)]
54[template mpfr[] [@http://www.mpfr.org MPFR]]
55[template mpc[] [@http://www.multiprecision.org MPC]]
56[template mpfi[] [@http://perso.ens-lyon.fr/nathalie.revol/software.html MPFI]]
57[template gmp[] [@http://gmplib.org GMP]]
58[template mpf_class[] [@http://gmplib.org/manual/C_002b_002b-Interface-Floats.html#C_002b_002b-Interface-Floats mpf_class]]
59[template mpfr_class[] [@http://math.berkeley.edu/~wilken/code/gmpfrxx/ mpfr_class]]
60[template mpreal[] [@http://www.holoborodko.com/pavel/mpfr/ mpreal]]
61[template mpir[] [@http://mpir.org/ MPIR]]
62[template tommath[] [@http://libtom.net libtommath]]
63[template quadmath[] [@http://gcc.gnu.org/onlinedocs/libquadmath/ libquadmath]]
64
65[template super[x]'''<superscript>'''[x]'''</superscript>''']
66[template sub[x]'''<subscript>'''[x]'''</subscript>''']
67
68[/insert Equation as a PNG or SVG image, previous generated with an external tool like Latex.]
69[/Used thus [equation ellint6]  - without the file type suffix which will chosen automatically.]
70
71[template equation[name]  '''<inlinemediaobject>
72<imageobject role="html">
73<imagedata fileref="../'''[name]'''.png"></imagedata>
74</imageobject>
75<imageobject role="print">
76<imagedata fileref="../'''[name]'''.svg"></imagedata>
77</imageobject>
78</inlinemediaobject>''']
79
80[/insert Indented one-line expression italic and serif font probably using Unicode symbols for Greek and symbols.]
81[/Example: [expression [sub 1]F[sub 0](a, z) = (1-z)[super -a]]]
82[template expression[equation]
83[:
84[role serif_italic [equation]]
85]
86[/ Hint you may need to enclose equation in brackets if it contains comma(s) to avoid "error invalid number of arguments"]
87]
88
89[def __tick [role aligncenter [role green \u2714]]] [/ u2714 is a HEAVY CHECK MARK tick (2713 check mark), green]
90[def __cross [role aligncenter [role red \u2718]]] [/ u2718 is a heavy cross, red]
91[def __star [role aligncenter [role red \u2736]]] [/ 6-point star red ]
92
93[/Boost.Multiprecision internals links]
94[def __cpp_int [link boost_multiprecision.tut.ints.cpp_int cpp_int]]
95[def __gmp_int [link boost_multiprecision.tut.ints.gmp_int gmp_int]]
96[def __tom_int [link boost_multiprecision.tut.ints.tom_int tom_int]]
97[def __gmp_float [link boost_multiprecision.tut.floats.gmp_float gmp_float]]
98[def __mpf_float [link boost_multiprecision.tut.floats.gmp_float gmp_float]]
99[def __mpfr_float_backend [link boost_multiprecision.tut.floats.mpfr_float mpfr_float]]
100[def __cpp_bin_float [link boost_multiprecision.tut.floats.cpp_bin_float cpp_bin_float]]
101[def __cpp_dec_float [link boost_multiprecision.tut.floats.cpp_dec_float cpp_dec_float]]
102[def __gmp_rational [link boost_multiprecision.tut.rational.gmp_rational gmp_rational]]
103[def __cpp_rational [link boost_multiprecision.tut.rational.cpp_rational cpp_rational]]
104[def __tommath_rational [link boost_multiprecision.tut.rational.tommath_rational tommath_rational]]
105[def __number [link boost_multiprecision.ref.number number]]
106[def __float128__ [link boost_multiprecision.tut.floats.float128 float128]]
107[def __cpp_complex [link boost_multiprecision.tut.complex.cpp_complex cpp_complex]]
108[def __mpc_complex [link boost_multiprecision.tut.complex.mpc_complex mpc_complex]]
109[def __debug_adaptor [link boost_multiprecision.tut.misc.debug_adaptor debug_adaptor]]
110[def __logged_adaptor [link boost_multiprecision.tut.misc.logged_adaptor logged_adaptor]]
111[def __rational_adaptor [link boost_multiprecision.tut.rational.rational_adaptor rational_adaptor]]
112[def __cpp_complex [link boost_multiprecision.tut.complex.cpp_complex cpp_complex]]
113[def __mpc_complex [link boost_multiprecision.tut.complex.mpc_complex mpc_complex]]
114[def __complex128 [link boost_multiprecision.tut.complex.complex128 complex128]]
115[def __complex_adaptor [link boost_multiprecision.tut.complex.complex_adaptor complex_adaptor]]
116[def __random [link boost_multiprecision.tut.random random number generation]]
117[def __literals [link boost_multiprecision.tut.lits literals]]
118
119[/External references links as macro definitions.]
120[def __expression_template [@https://en.wikipedia.org/wiki/Expression_templates expression template]]
121[def __expression_templates [@https://en.wikipedia.org/wiki/Expression_templates expression templates]] [/plural version]
122[def __UDT [@http://eel.is/c++draft/definitions#defns.prog.def.type program-defined type]]
123[def __fundamental_type [@https://en.cppreference.com/w/cpp/language/types fundamental (built-in) type]]
124[def __fundamental_types [@https://en.cppreference.com/w/cpp/language/types fundamental (built-in) types]]
125[def __fundamental [@https://en.cppreference.com/w/cpp/language/types fundamental (built-in)]]
126[def __math_constants [@https://www.boost.org/doc/libs/release/libs/math/doc/html/math_toolkit/constants.html  Boost.Math constants]]
127[def __boost_macros [@https://www.boost.org/doc/libs/release/libs/config/doc/html/boost_config/boost_macro_reference.html Boost macros]]
128[def __boost_config [@https://www.boost.org/doc/libs/release/libs/config/doc/html/index.html Boost.Config]]
129[def __is_constant_evaluated [@https://en.cppreference.com/w/cpp/types/is_constant_evaluated `std::is_constant_evaluated`]]
130[def __compiler_support [@https://en.cppreference.com/w/cpp/compiler_support compiler support]]
131[def __ULP [@http://en.wikipedia.org/wiki/Unit_in_the_last_place  Unit in the last place (ULP)]]
132[def __Mathematica [@http://www.wolfram.com/products/mathematica/index.html Wolfram Mathematica]]
133[def __WolframAlpha [@http://www.wolframalpha.com/ Wolfram Alpha]]
134[def __Boost_Serialization [@https://www.boost.org/doc/libs/release/libs/serialization/doc/index.html Boost.Serialization]]
135[def __Boost_Math [@https://www.boost.org/doc/libs/release/libs/math/doc/index.html Boost.Math]]
136[def __Boost_Multiprecision [@https://www.boost.org/doc/libs/release/libs/multiprecision/doc/index.html Boost.Multiprecision]]
137
138[include introduction.qbk]
139
140[include tutorial.qbk]
141[include reference.qbk]
142[include performance.qbk]
143[include history.qbk]
144
145[section:indexes Indexes]
146
147'''
148<index type="function_name">
149<title>Function Index</title>
150</index>
151
152<index type="class_name">
153<title>Class Index</title>
154</index>
155
156<index type="typedef_name">
157<title>Typedef Index</title>
158</index>
159
160<index/>
161'''
162
163[endsect]
164