headers.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Header File Structure</title>
  5. <link rel="stylesheet" href="../../multiprecision.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
  7. <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Multiprecision">
  8. <link rel="up" href="../ref.html" title="Reference">
  9. <link rel="prev" href="backendconc.html" title="Backend Requirements">
  10. <link rel="next" href="../perf.html" title="Performance Comparison">
  11. </head>
  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13. <table cellpadding="2" width="100%"><tr>
  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15. <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16. <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19. <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20. </tr></table>
  21. <hr>
  22. <div class="spirit-nav">
  23. <a accesskey="p" href="backendconc.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../perf.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h3 class="title">
  27. <a name="boost_multiprecision.ref.headers"></a><a class="link" href="headers.html" title="Header File Structure">Header File Structure</a>
  28. </h3></div></div></div>
  29. <div class="table">
  30. <a name="boost_multiprecision.ref.headers.top_level_headers"></a><p class="title"><b>Table&#160;1.10.&#160;Top level headers</b></p>
  31. <div class="table-contents"><table class="table" summary="Top level headers">
  32. <colgroup>
  33. <col>
  34. <col>
  35. </colgroup>
  36. <thead><tr>
  37. <th>
  38. <p>
  39. Header
  40. </p>
  41. </th>
  42. <th>
  43. <p>
  44. Contains
  45. </p>
  46. </th>
  47. </tr></thead>
  48. <tbody>
  49. <tr>
  50. <td>
  51. <p>
  52. cpp_int.hpp
  53. </p>
  54. </td>
  55. <td>
  56. <p>
  57. The <code class="computeroutput"><span class="identifier">cpp_int</span></code> backend
  58. type.
  59. </p>
  60. </td>
  61. </tr>
  62. <tr>
  63. <td>
  64. <p>
  65. gmp.hpp
  66. </p>
  67. </td>
  68. <td>
  69. <p>
  70. Defines all <a href="http://gmplib.org" target="_top">GMP</a> related
  71. backends.
  72. </p>
  73. </td>
  74. </tr>
  75. <tr>
  76. <td>
  77. <p>
  78. miller_rabin.hpp
  79. </p>
  80. </td>
  81. <td>
  82. <p>
  83. Miller Rabin primality testing code.
  84. </p>
  85. </td>
  86. </tr>
  87. <tr>
  88. <td>
  89. <p>
  90. number.hpp
  91. </p>
  92. </td>
  93. <td>
  94. <p>
  95. Defines the <code class="computeroutput"><span class="identifier">number</span></code>
  96. backend, is included by all the backend headers.
  97. </p>
  98. </td>
  99. </tr>
  100. <tr>
  101. <td>
  102. <p>
  103. mpfr.hpp
  104. </p>
  105. </td>
  106. <td>
  107. <p>
  108. Defines the mpfr_float_backend backend.
  109. </p>
  110. </td>
  111. </tr>
  112. <tr>
  113. <td>
  114. <p>
  115. random.hpp
  116. </p>
  117. </td>
  118. <td>
  119. <p>
  120. Defines code to interoperate with Boost.Random.
  121. </p>
  122. </td>
  123. </tr>
  124. <tr>
  125. <td>
  126. <p>
  127. rational_adaptor.hpp
  128. </p>
  129. </td>
  130. <td>
  131. <p>
  132. Defines the <code class="computeroutput"><span class="identifier">rational_adaptor</span></code>
  133. backend.
  134. </p>
  135. </td>
  136. </tr>
  137. <tr>
  138. <td>
  139. <p>
  140. cpp_dec_float.hpp
  141. </p>
  142. </td>
  143. <td>
  144. <p>
  145. Defines the <code class="computeroutput"><span class="identifier">cpp_dec_float</span></code>
  146. backend.
  147. </p>
  148. </td>
  149. </tr>
  150. <tr>
  151. <td>
  152. <p>
  153. tommath.hpp
  154. </p>
  155. </td>
  156. <td>
  157. <p>
  158. Defines the <code class="computeroutput"><span class="identifier">tommath_int</span></code>
  159. backend.
  160. </p>
  161. </td>
  162. </tr>
  163. <tr>
  164. <td>
  165. <p>
  166. concepts/number_archetypes.hpp
  167. </p>
  168. </td>
  169. <td>
  170. <p>
  171. Defines a backend concept archetypes for testing use.
  172. </p>
  173. </td>
  174. </tr>
  175. </tbody>
  176. </table></div>
  177. </div>
  178. <br class="table-break"><div class="table">
  179. <a name="boost_multiprecision.ref.headers.implementation_headers"></a><p class="title"><b>Table&#160;1.11.&#160;Implementation Headers</b></p>
  180. <div class="table-contents"><table class="table" summary="Implementation Headers">
  181. <colgroup>
  182. <col>
  183. <col>
  184. </colgroup>
  185. <thead><tr>
  186. <th>
  187. <p>
  188. Header
  189. </p>
  190. </th>
  191. <th>
  192. <p>
  193. Contains
  194. </p>
  195. </th>
  196. </tr></thead>
  197. <tbody>
  198. <tr>
  199. <td>
  200. <p>
  201. cpp_int/add.hpp
  202. </p>
  203. </td>
  204. <td>
  205. <p>
  206. Add and subtract operators for <code class="computeroutput"><span class="identifier">cpp_int_backend</span></code>.
  207. </p>
  208. </td>
  209. </tr>
  210. <tr>
  211. <td>
  212. <p>
  213. cpp_int/bitwise.hpp
  214. </p>
  215. </td>
  216. <td>
  217. <p>
  218. Bitwise operators for <code class="computeroutput"><span class="identifier">cpp_int_backend</span></code>.
  219. </p>
  220. </td>
  221. </tr>
  222. <tr>
  223. <td>
  224. <p>
  225. cpp_int/checked.hpp
  226. </p>
  227. </td>
  228. <td>
  229. <p>
  230. Helper functions for checked arithmetic for <code class="computeroutput"><span class="identifier">cpp_int_backend</span></code>.
  231. </p>
  232. </td>
  233. </tr>
  234. <tr>
  235. <td>
  236. <p>
  237. cpp_int/comparison.hpp
  238. </p>
  239. </td>
  240. <td>
  241. <p>
  242. Comparison operators for <code class="computeroutput"><span class="identifier">cpp_int_backend</span></code>.
  243. </p>
  244. </td>
  245. </tr>
  246. <tr>
  247. <td>
  248. <p>
  249. cpp_int/cpp_int_config.hpp
  250. </p>
  251. </td>
  252. <td>
  253. <p>
  254. Basic setup and configuration for <code class="computeroutput"><span class="identifier">cpp_int_backend</span></code>.
  255. </p>
  256. </td>
  257. </tr>
  258. <tr>
  259. <td>
  260. <p>
  261. cpp_int/divide.hpp
  262. </p>
  263. </td>
  264. <td>
  265. <p>
  266. Division and modulus operators for <code class="computeroutput"><span class="identifier">cpp_int_backend</span></code>.
  267. </p>
  268. </td>
  269. </tr>
  270. <tr>
  271. <td>
  272. <p>
  273. cpp_int/limits.hpp
  274. </p>
  275. </td>
  276. <td>
  277. <p>
  278. <code class="computeroutput"><span class="identifier">numeric_limits</span></code>
  279. support for <code class="computeroutput"><span class="identifier">cpp_int_backend</span></code>.
  280. </p>
  281. </td>
  282. </tr>
  283. <tr>
  284. <td>
  285. <p>
  286. cpp_int/misc.hpp
  287. </p>
  288. </td>
  289. <td>
  290. <p>
  291. Miscellaneous operators for <code class="computeroutput"><span class="identifier">cpp_int_backend</span></code>.
  292. </p>
  293. </td>
  294. </tr>
  295. <tr>
  296. <td>
  297. <p>
  298. cpp_int/multiply.hpp
  299. </p>
  300. </td>
  301. <td>
  302. <p>
  303. Multiply operators for <code class="computeroutput"><span class="identifier">cpp_int_backend</span></code>.
  304. </p>
  305. </td>
  306. </tr>
  307. <tr>
  308. <td>
  309. <p>
  310. detail/big_lanczos.hpp
  311. </p>
  312. </td>
  313. <td>
  314. <p>
  315. Lanczos support for Boost.Math integration.
  316. </p>
  317. </td>
  318. </tr>
  319. <tr>
  320. <td>
  321. <p>
  322. detail/default_ops.hpp
  323. </p>
  324. </td>
  325. <td>
  326. <p>
  327. Default versions of the optional backend non-member functions.
  328. </p>
  329. </td>
  330. </tr>
  331. <tr>
  332. <td>
  333. <p>
  334. detail/generic_interconvert.hpp
  335. </p>
  336. </td>
  337. <td>
  338. <p>
  339. Generic interconversion routines.
  340. </p>
  341. </td>
  342. </tr>
  343. <tr>
  344. <td>
  345. <p>
  346. detail/number_base.hpp
  347. </p>
  348. </td>
  349. <td>
  350. <p>
  351. All the expression template code, metaprogramming, and operator
  352. overloads for <code class="computeroutput"><span class="identifier">number</span></code>.
  353. </p>
  354. </td>
  355. </tr>
  356. <tr>
  357. <td>
  358. <p>
  359. detail/no_et_ops.hpp
  360. </p>
  361. </td>
  362. <td>
  363. <p>
  364. The non-expression template operators.
  365. </p>
  366. </td>
  367. </tr>
  368. <tr>
  369. <td>
  370. <p>
  371. detail/functions/constants.hpp
  372. </p>
  373. </td>
  374. <td>
  375. <p>
  376. Defines constants used by the floating-point functions.
  377. </p>
  378. </td>
  379. </tr>
  380. <tr>
  381. <td>
  382. <p>
  383. detail/functions/pow.hpp
  384. </p>
  385. </td>
  386. <td>
  387. <p>
  388. Defines default versions of the power and exponential related floating-point
  389. functions.
  390. </p>
  391. </td>
  392. </tr>
  393. <tr>
  394. <td>
  395. <p>
  396. detail/functions/trig.hpp
  397. </p>
  398. </td>
  399. <td>
  400. <p>
  401. Defines default versions of the trigonometric related floating-point
  402. functions.
  403. </p>
  404. </td>
  405. </tr>
  406. </tbody>
  407. </table></div>
  408. </div>
  409. <br class="table-break">
  410. </div>
  411. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  412. <td align="left"></td>
  413. <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2019 John Maddock
  414. and Christopher Kormanyos<p>
  415. Distributed under the Boost Software License, Version 1.0. (See accompanying
  416. file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  417. </p>
  418. </div></td>
  419. </tr></table>
  420. <hr>
  421. <div class="spirit-nav">
  422. <a accesskey="p" href="backendconc.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../perf.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  423. </div>
  424. </body>
  425. </html>