modules.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187
  1. <!--
  2. Copyright Louis Dionne 2013-2017
  3. Distributed under the Boost Software License, Version 1.0.
  4. (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)
  5. -->
  6. <!-- boost-no-inspect -->
  7. <!-- HTML header for doxygen 1.8.9.1-->
  8. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  9. <html xmlns="http://www.w3.org/1999/xhtml">
  10. <head>
  11. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  12. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  13. <meta name="generator" content="Doxygen 1.8.15"/>
  14. <title>Boost.Hana: Reference documentation</title>
  15. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  16. <script type="text/javascript" src="jquery.js"></script>
  17. <script type="text/javascript" src="dynsections.js"></script>
  18. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="resize.js"></script>
  20. <script type="text/javascript" src="navtreedata.js"></script>
  21. <script type="text/javascript" src="navtree.js"></script>
  22. <script type="text/javascript">
  23. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  24. $(document).ready(initResizable);
  25. /* @license-end */</script>
  26. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  27. <script type="text/javascript" src="search/searchdata.js"></script>
  28. <script type="text/javascript" src="search/search.js"></script>
  29. <script type="text/javascript">
  30. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  31. $(document).ready(function() { init_search(); });
  32. /* @license-end */
  33. </script>
  34. <script type="text/x-mathjax-config">
  35. MathJax.Hub.Config({
  36. extensions: ["tex2jax.js"],
  37. jax: ["input/TeX","output/HTML-CSS"],
  38. });
  39. // Copyright Louis Dionne 2013-2017
  40. // Distributed under the Boost Software License, Version 1.0.
  41. // (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)
  42. MathJax.Hub.Config({
  43. "HTML-CSS": {
  44. linebreaks: {
  45. automatic: true,
  46. width: "75% container"
  47. }
  48. }
  49. });
  50. </script><script type="text/javascript" async="async" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  51. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  52. <!-- Additional javascript for drawing charts. -->
  53. <script type="text/javascript" src="highcharts.js"></script>
  54. <script type="text/javascript" src="highcharts-data.js"></script>
  55. <script type="text/javascript" src="highcharts-exporting.js"></script>
  56. <script type="text/javascript" src="chart.js"></script>
  57. <script type="text/javascript" src="hana.js"></script>
  58. </head>
  59. <body>
  60. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  61. <div id="titlearea">
  62. <table cellspacing="0" cellpadding="0">
  63. <tbody>
  64. <tr style="height: 56px;">
  65. <td id="projectlogo"><img alt="Logo" src="Boost.png"/></td>
  66. <td style="padding-left: 0.5em;">
  67. <div id="projectname">Boost.Hana
  68. &#160;<span id="projectnumber">1.6.0</span>
  69. </div>
  70. <div id="projectbrief">Your standard library for metaprogramming</div>
  71. </td>
  72. <td> <div id="MSearchBox" class="MSearchBoxInactive">
  73. <span class="left">
  74. <img id="MSearchSelect" src="search/mag_sel.png"
  75. onmouseover="return searchBox.OnSearchSelectShow()"
  76. onmouseout="return searchBox.OnSearchSelectHide()"
  77. alt=""/>
  78. <input type="text" id="MSearchField" value="Search" accesskey="S"
  79. onfocus="searchBox.OnSearchFieldFocus(true)"
  80. onblur="searchBox.OnSearchFieldFocus(false)"
  81. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  82. </span><span class="right">
  83. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  84. </span>
  85. </div>
  86. </td>
  87. </tr>
  88. </tbody>
  89. </table>
  90. </div>
  91. <!-- end header part -->
  92. <!-- Generated by Doxygen 1.8.15 -->
  93. <script type="text/javascript">
  94. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  95. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  96. /* @license-end */
  97. </script>
  98. </div><!-- top -->
  99. <div id="side-nav" class="ui-resizable side-nav-resizable">
  100. <div id="nav-tree">
  101. <div id="nav-tree-contents">
  102. <div id="nav-sync" class="sync"></div>
  103. </div>
  104. </div>
  105. <div id="splitbar" style="-moz-user-select:none;"
  106. class="ui-resizable-handle">
  107. </div>
  108. </div>
  109. <script type="text/javascript">
  110. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  111. $(document).ready(function(){initNavTree('modules.html','');});
  112. /* @license-end */
  113. </script>
  114. <div id="doc-content">
  115. <!-- window showing the filter options -->
  116. <div id="MSearchSelectWindow"
  117. onmouseover="return searchBox.OnSearchSelectShow()"
  118. onmouseout="return searchBox.OnSearchSelectHide()"
  119. onkeydown="return searchBox.OnSearchSelectKey(event)">
  120. </div>
  121. <!-- iframe showing the search results (closed by default) -->
  122. <div id="MSearchResultsWindow">
  123. <iframe src="javascript:void(0)" frameborder="0"
  124. name="MSearchResults" id="MSearchResults">
  125. </iframe>
  126. </div>
  127. <div class="header">
  128. <div class="headertitle">
  129. <div class="title">Reference documentation</div> </div>
  130. </div><!--header-->
  131. <div class="contents">
  132. <div class="textblock"> The reference documentation is split into logical modules, as documented in the user manual.</div><div class="directory">
  133. <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
  134. <tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><a class="el" href="group__group-concepts.html" target="_self">Concepts</a></td><td class="desc">Concepts provided by the library </td></tr>
  135. <tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Applicative.html" target="_self">Applicative</a></td><td class="desc">The <code>Applicative</code> concept represents <code>Functor</code>s with the ability to lift values and combine computations </td></tr>
  136. <tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Comonad.html" target="_self">Comonad</a></td><td class="desc">The <code>Comonad</code> concept represents context-sensitive computations and data </td></tr>
  137. <tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Comparable.html" target="_self">Comparable</a></td><td class="desc">The <code>Comparable</code> concept defines equality and inequality </td></tr>
  138. <tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Constant.html" target="_self">Constant</a></td><td class="desc">The <code>Constant</code> concept represents data that can be manipulated at compile-time </td></tr>
  139. <tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-EuclideanRing.html" target="_self">Euclidean Ring</a></td><td class="desc">The <code>EuclideanRing</code> concept represents a commutative <code>Ring</code> that can also be endowed with a division algorithm </td></tr>
  140. <tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Foldable.html" target="_self">Foldable</a></td><td class="desc">The <code>Foldable</code> concept represents data structures that can be reduced to a single value </td></tr>
  141. <tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Functor.html" target="_self">Functor</a></td><td class="desc">The <code>Functor</code> concept represents types that can be mapped over </td></tr>
  142. <tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Group.html" target="_self">Group</a></td><td class="desc">The <code>Group</code> concept represents <code>Monoid</code>s where all objects have an inverse w.r.t. the <code>Monoid</code>'s binary operation </td></tr>
  143. <tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Hashable.html" target="_self">Hashable</a></td><td class="desc">The <code>Hashable</code> concept represents objects that can be normalized to a type-level hash </td></tr>
  144. <tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Iterable.html" target="_self">Iterable</a></td><td class="desc">The <code>Iterable</code> concept represents data structures supporting external iteration </td></tr>
  145. <tr id="row_0_10_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Logical.html" target="_self">Logical</a></td><td class="desc">The <code>Logical</code> concept represents types with a truth value </td></tr>
  146. <tr id="row_0_11_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Metafunction.html" target="_self">Metafunction</a></td><td class="desc">A <code>Metafunction</code> is a function that takes <code><a class="el" href="structboost_1_1hana_1_1type.html" title="C++ type in value-level representation.">hana::type</a></code>s as inputs and returns a <code><a class="el" href="structboost_1_1hana_1_1type.html" title="C++ type in value-level representation.">hana::type</a></code> as output </td></tr>
  147. <tr id="row_0_12_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Monad.html" target="_self">Monad</a></td><td class="desc">The <code>Monad</code> concept represents <code>Applicative</code>s with the ability to flatten nested levels of structure </td></tr>
  148. <tr id="row_0_13_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-MonadPlus.html" target="_self">MonadPlus</a></td><td class="desc">The <code>MonadPlus</code> concept represents Monads with a monoidal structure </td></tr>
  149. <tr id="row_0_14_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Monoid.html" target="_self">Monoid</a></td><td class="desc">The <code>Monoid</code> concept represents data types with an associative binary operation that has an identity </td></tr>
  150. <tr id="row_0_15_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Orderable.html" target="_self">Orderable</a></td><td class="desc">The <code>Orderable</code> concept represents totally ordered data types </td></tr>
  151. <tr id="row_0_16_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Product.html" target="_self">Product</a></td><td class="desc">Represents types that are generic containers of two elements </td></tr>
  152. <tr id="row_0_17_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Ring.html" target="_self">Ring</a></td><td class="desc">The <code>Ring</code> concept represents <code>Group</code>s that also form a <code>Monoid</code> under a second binary operation that distributes over the first </td></tr>
  153. <tr id="row_0_18_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Searchable.html" target="_self">Searchable</a></td><td class="desc">The <code>Searchable</code> concept represents structures that can be searched </td></tr>
  154. <tr id="row_0_19_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Sequence.html" target="_self">Sequence</a></td><td class="desc">The <code>Sequence</code> concept represents generic index-based sequences </td></tr>
  155. <tr id="row_0_20_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-Struct.html" target="_self">Struct</a></td><td class="desc">The <code>Struct</code> concept represents <code>struct</code>-like user-defined types </td></tr>
  156. <tr id="row_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="group__group-datatypes.html" target="_self">Data types</a></td><td class="desc">General purpose data types provided by the library </td></tr>
  157. <tr id="row_2_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="group__group-functional.html" target="_self">Functional</a></td><td class="desc">General purpose function objects </td></tr>
  158. <tr id="row_3_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="group__group-core.html" target="_self">Core</a></td><td class="desc">Core utilities of the library </td></tr>
  159. <tr id="row_4_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="group__group-experimental.html" target="_self">Experimental features</a></td><td class="desc">Experimental features that may or may not make it into the library. These features should not expected to be stable </td></tr>
  160. <tr id="row_5_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_5_" class="arrow" onclick="toggleFolder('5_')">&#9660;</span><a class="el" href="group__group-ext.html" target="_self">External adapters</a></td><td class="desc">Adapters for external libraries </td></tr>
  161. <tr id="row_5_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-ext-fusion.html" target="_self">Boost.Fusion adapters</a></td><td class="desc">Adapters for Boost.Fusion containers </td></tr>
  162. <tr id="row_5_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-ext-mpl.html" target="_self">Boost.MPL adapters</a></td><td class="desc">Adapters for Boost.MPL containers </td></tr>
  163. <tr id="row_5_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-ext-boost.html" target="_self">Other Boost adapters</a></td><td class="desc">Adapters for miscellaneous heterogeneous containers in Boost </td></tr>
  164. <tr id="row_5_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__group-ext-std.html" target="_self">Standard library adapters</a></td><td class="desc">Adapters for components in the standard library </td></tr>
  165. <tr id="row_6_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="group__group-config.html" target="_self">Configuration options</a></td><td class="desc">Configurable options to tweak the global behavior of the library </td></tr>
  166. <tr id="row_7_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="group__group-assertions.html" target="_self">Assertions</a></td><td class="desc">Macros to perform different kinds of assertions </td></tr>
  167. <tr id="row_8_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="group__group-details.html" target="_self">Details</a></td><td class="desc">Implementation details. Do not rely on anything here, even if it is documented </td></tr>
  168. </table>
  169. </div><!-- directory -->
  170. </div><!-- contents -->
  171. </div><!-- doc-content -->
  172. <!--
  173. Copyright Louis Dionne 2013-2017
  174. Distributed under the Boost Software License, Version 1.0.
  175. (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)
  176. -->
  177. <!-- boost-no-inspect -->
  178. <!-- HTML footer for doxygen 1.8.9.1-->
  179. <!-- start footer part -->
  180. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  181. <ul>
  182. </ul>
  183. </div>
  184. </body>
  185. </html>