structboost_1_1hana_1_1tuple.html 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469
  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: boost::hana::tuple&lt; Xn &gt; Struct Template Reference</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('structboost_1_1hana_1_1tuple.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="summary">
  129. <a href="#related">Synopsis of associated functions</a> &#124;
  130. <a href="#friends">Friends</a> &#124;
  131. <a href="#pub-methods">Public Member Functions</a> &#124;
  132. <a href="structboost_1_1hana_1_1tuple-members.html">List of all members</a> </div>
  133. <div class="headertitle">
  134. <div class="title">boost::hana::tuple&lt; Xn &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group__group-datatypes.html">Data types</a></div></div> </div>
  135. </div><!--header-->
  136. <div class="contents">
  137. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  138. <div class="textblock"><h3>template&lt;typename ... Xn&gt;<br />
  139. struct boost::hana::tuple&lt; Xn &gt;</h3>
  140. <p>General purpose index-based heterogeneous sequence with a fixed length. </p>
  141. <p>The tuple is the bread and butter for static metaprogramming. Conceptually, it is like a <code><a class="el" href="structstd_1_1tuple.html" title="Adapter for std::tuples.">std::tuple</a></code>; it is a container able of holding objects of different types and whose size is fixed at compile-time. However, Hana's tuple provides much more functionality than its <code>std</code> counterpart, and it is also much more efficient than all standard library implementations tested so far.</p>
  142. <p>Tuples are index-based sequences. If you need an associative sequence with a key-based access, then you should consider <code><a class="el" href="structboost_1_1hana_1_1map.html" title="Basic associative container requiring unique, Comparable and Hashable keys.">hana::map</a></code> or <code><a class="el" href="structboost_1_1hana_1_1set.html" title="Basic unordered container requiring unique, Comparable and Hashable keys.">hana::set</a></code> instead.</p>
  143. <dl class="section note"><dt>Note</dt><dd>When you use a container, remember not to make assumptions about its representation, unless the documentation gives you those guarantees. More details <a class="el" href="index.html#tutorial-containers-types">in the tutorial</a>.</dd></dl>
  144. <h2>Modeled concepts </h2>
  145. <p><code>Sequence</code>, and all the concepts it refines</p>
  146. <h2>Provided operators </h2>
  147. <p>For convenience, the following operators are provided: </p><div class="fragment"><div class="line">xs == ys -&gt; <a class="code" href="group__group-Comparable.html#gacaf1ebea6b3ab96ac9dcb82f0e64e547">equal</a>(xs, ys)</div><div class="line">xs != ys -&gt; <a class="code" href="group__group-Comparable.html#gae33be2e0d5e04f19082f4b7740dfc9cd">not_equal</a>(xs, ys)</div><div class="line"></div><div class="line">xs &lt; ys -&gt; <a class="code" href="group__group-Orderable.html#gad510011602bdb14686f1c4ec145301c9">less</a>(xs, ys)</div><div class="line">xs &lt;= ys -&gt; <a class="code" href="group__group-Orderable.html#ga9917dd82beb67151bf5657245d37b851">less_equal</a>(xs, ys)</div><div class="line">xs &gt; ys -&gt; <a class="code" href="group__group-Orderable.html#gaf9a073eafebbe514fb19dff82318f198">greater</a>(xs, ys)</div><div class="line">xs &gt;= ys -&gt; <a class="code" href="group__group-Orderable.html#ga6023631e7d0a01e16dc3fa4221fbd703">greater_equal</a>(xs, ys)</div><div class="line"></div><div class="line">xs | f -&gt; <a class="code" href="group__group-Monad.html#ga05fdc2f887cb9967357487a432ace98b">chain</a>(xs, f)</div><div class="line"></div><div class="line">xs[n] -&gt; <a class="code" href="group__group-Iterable.html#ga8a484304380eae38f3d9663d98860129">at</a>(xs, n)</div></div><!-- fragment --><h2>Example </h2>
  148. <div class="fragment"><div class="line"><span class="comment">// Copyright Louis Dionne 2013-2017</span></div><div class="line"><span class="comment">// Distributed under the Boost Software License, Version 1.0.</span></div><div class="line"><span class="comment">// (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)</span></div><div class="line"></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="assert_8hpp.html">boost/hana/assert.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="equal_8hpp.html">boost/hana/equal.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="integral__constant_8hpp.html">boost/hana/integral_constant.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="transform_8hpp.html">boost/hana/transform.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="tuple_8hpp.html">boost/hana/tuple.hpp</a>&gt;</span></div><div class="line"></div><div class="line"><span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><span class="keyword">namespace </span>hana = <a class="code" href="namespaceboost_1_1hana.html">boost::hana</a>;</div><div class="line"><span class="keyword">using namespace </span>hana::literals;</div><div class="line"></div><div class="line"></div><div class="line"><span class="keyword">struct </span>Fish { std::string name; };</div><div class="line"><span class="keyword">struct </span>Cat { std::string name; };</div><div class="line"><span class="keyword">struct </span>Dog { std::string name; };</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main() {</div><div class="line"> hana::tuple&lt;Fish, Cat, Dog&gt; animals{{<span class="stringliteral">&quot;Nemo&quot;</span>}, {<span class="stringliteral">&quot;Garfield&quot;</span>}, {<span class="stringliteral">&quot;Snoopy&quot;</span>}};</div><div class="line"> animals[0_c].name = <span class="stringliteral">&quot;Moby Dick&quot;</span>; <span class="comment">// can modify elements in place, like std::tuple</span></div><div class="line"></div><div class="line"> <span class="keyword">auto</span> names = <a class="code" href="group__group-Functor.html#ga5a8975f6e55375d5b6038a9c36ee63e7">hana::transform</a>(animals, [](<span class="keyword">auto</span> a) {</div><div class="line"> <span class="keywordflow">return</span> a.name;</div><div class="line"> });</div><div class="line"></div><div class="line"> <a class="code" href="group__group-assertions.html#ga4796ae107d58b67e0bbccd5ae6f70101">BOOST_HANA_RUNTIME_CHECK</a>(names == hana::make_tuple(<span class="stringliteral">&quot;Moby Dick&quot;</span>, <span class="stringliteral">&quot;Garfield&quot;</span>, <span class="stringliteral">&quot;Snoopy&quot;</span>));</div><div class="line">}</div></div><!-- fragment --> </div><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  149. <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for boost::hana::tuple&lt; Xn &gt;:</div>
  150. <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  151. </div>
  152. <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  153. <div class="center">
  154. <img src="structboost_1_1hana_1_1tuple.png" usemap="#boost::hana::tuple_3C_20Xn_20_3E_map" alt=""/>
  155. <map id="boost::hana::tuple_3C_20Xn_20_3E_map" name="boost::hana::tuple_3C_20Xn_20_3E_map">
  156. <area href="structboost_1_1hana_1_1detail_1_1operators_1_1adl.html" alt="boost::hana::detail::operators::adl&lt; tuple&lt; Xn... &gt; &gt;" shape="rect" coords="0,0,298,24"/>
  157. </map>
  158. </div></div>
  159. <table class="memberdecls">
  160. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
  161. Synopsis of associated functions</h2></td></tr>
  162. <tr class="memitem:ad9d8c7efa77e573eba2dfc48b3343e66"><td class="memTemplParams" colspan="2">template&lt;&gt; </td></tr>
  163. <tr class="memitem:ad9d8c7efa77e573eba2dfc48b3343e66"><td class="memTemplItemLeft" align="right" valign="top">constexpr auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#ad9d8c7efa77e573eba2dfc48b3343e66">make&lt; tuple_tag &gt;</a></td></tr>
  164. <tr class="memdesc:ad9d8c7efa77e573eba2dfc48b3343e66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function object for creating a <code>tuple</code>. <a href="#ad9d8c7efa77e573eba2dfc48b3343e66">More...</a><br /></td></tr>
  165. <tr class="separator:ad9d8c7efa77e573eba2dfc48b3343e66"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:af3c175cfb83276339f91e867d738a2e6"><td class="memItemLeft" align="right" valign="top">constexpr auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#af3c175cfb83276339f91e867d738a2e6">make_tuple</a> = <a class="el" href="group__group-core.html#ga1d92480f0af1029878e773dafa3e2f60">make</a>&lt;<a class="el" href="structboost_1_1hana_1_1tuple__tag.html">tuple_tag</a>&gt;</td></tr>
  167. <tr class="memdesc:af3c175cfb83276339f91e867d738a2e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias to <code>make&lt;<a class="el" href="structboost_1_1hana_1_1tuple__tag.html" title="Tag representing hana::tuples.">tuple_tag</a>&gt;</code>; provided for convenience. <a href="#af3c175cfb83276339f91e867d738a2e6">More...</a><br /></td></tr>
  168. <tr class="separator:af3c175cfb83276339f91e867d738a2e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:a749b564c8f115957837761d75191beac"><td class="memItemLeft" align="right" valign="top">constexpr auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#a749b564c8f115957837761d75191beac">to_tuple</a> = <a class="el" href="group__group-core.html#gadc70755c1d059139297814fb3bfeb91e">to</a>&lt;<a class="el" href="structboost_1_1hana_1_1tuple__tag.html">tuple_tag</a>&gt;</td></tr>
  170. <tr class="memdesc:a749b564c8f115957837761d75191beac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code>to&lt;<a class="el" href="structboost_1_1hana_1_1tuple__tag.html" title="Tag representing hana::tuples.">tuple_tag</a>&gt;</code>; provided for convenience. <a href="#a749b564c8f115957837761d75191beac">More...</a><br /></td></tr>
  171. <tr class="separator:a749b564c8f115957837761d75191beac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:a1997546daf58a48cc15498d338a03da3"><td class="memTemplParams" colspan="2">template&lt;typename ... T&gt; </td></tr>
  173. <tr class="memitem:a1997546daf58a48cc15498d338a03da3"><td class="memTemplItemLeft" align="right" valign="top">constexpr implementation_defined&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#a1997546daf58a48cc15498d338a03da3">tuple_t</a> {}</td></tr>
  174. <tr class="memdesc:a1997546daf58a48cc15498d338a03da3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a tuple specialized for holding <code><a class="el" href="structboost_1_1hana_1_1type.html" title="C++ type in value-level representation.">hana::type</a></code>s. <a href="#a1997546daf58a48cc15498d338a03da3">More...</a><br /></td></tr>
  175. <tr class="separator:a1997546daf58a48cc15498d338a03da3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <tr class="memitem:a85c2f16caa2a1e12eefd1b3f69fa658e"><td class="memTemplParams" colspan="2">template&lt;typename T , T ... v&gt; </td></tr>
  177. <tr class="memitem:a85c2f16caa2a1e12eefd1b3f69fa658e"><td class="memTemplItemLeft" align="right" valign="top">constexpr implementation_defined&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#a85c2f16caa2a1e12eefd1b3f69fa658e">tuple_c</a> {}</td></tr>
  178. <tr class="memdesc:a85c2f16caa2a1e12eefd1b3f69fa658e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a tuple specialized for holding <code><a class="el" href="structboost_1_1hana_1_1integral__constant.html" title="Compile-time value of an integral type.">hana::integral_constant</a></code>s. <a href="#a85c2f16caa2a1e12eefd1b3f69fa658e">More...</a><br /></td></tr>
  179. <tr class="separator:a85c2f16caa2a1e12eefd1b3f69fa658e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. </table><table class="memberdecls">
  181. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  182. Friends</h2></td></tr>
  183. <tr class="memitem:a59b4d21f17e2caed8c31d8389d0f0878"><td class="memTemplParams" colspan="2"><a id="a59b4d21f17e2caed8c31d8389d0f0878"></a>
  184. template&lt;typename ... T, typename F &gt; </td></tr>
  185. <tr class="memitem:a59b4d21f17e2caed8c31d8389d0f0878"><td class="memTemplItemLeft" align="right" valign="top">constexpr auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#a59b4d21f17e2caed8c31d8389d0f0878">operator|</a> (<a class="el" href="structboost_1_1hana_1_1tuple.html">tuple</a>&lt; T... &gt;, F)</td></tr>
  186. <tr class="memdesc:a59b4d21f17e2caed8c31d8389d0f0878"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code><a class="el" href="group__group-Monad.html#ga05fdc2f887cb9967357487a432ace98b" title="Feed a monadic value into a monadic computation.Given a monadic value and a monadic function,...">hana::chain</a></code>. <br /></td></tr>
  187. <tr class="separator:a59b4d21f17e2caed8c31d8389d0f0878"><td class="memSeparator" colspan="2">&#160;</td></tr>
  188. <tr class="memitem:a27607958295e6da8a0ba602a2db468f1"><td class="memTemplParams" colspan="2"><a id="a27607958295e6da8a0ba602a2db468f1"></a>
  189. template&lt;typename X , typename Y &gt; </td></tr>
  190. <tr class="memitem:a27607958295e6da8a0ba602a2db468f1"><td class="memTemplItemLeft" align="right" valign="top">constexpr auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#a27607958295e6da8a0ba602a2db468f1">operator==</a> (X &amp;&amp;x, Y &amp;&amp;y)</td></tr>
  191. <tr class="memdesc:a27607958295e6da8a0ba602a2db468f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code><a class="el" href="group__group-Comparable.html#gacaf1ebea6b3ab96ac9dcb82f0e64e547" title="Returns a Logical representing whether x is equal to y.The equal function can be called in two differ...">hana::equal</a></code> <br /></td></tr>
  192. <tr class="separator:a27607958295e6da8a0ba602a2db468f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:a0cae3af55edb3eb05bfa184bda633f7d"><td class="memTemplParams" colspan="2"><a id="a0cae3af55edb3eb05bfa184bda633f7d"></a>
  194. template&lt;typename X , typename Y &gt; </td></tr>
  195. <tr class="memitem:a0cae3af55edb3eb05bfa184bda633f7d"><td class="memTemplItemLeft" align="right" valign="top">constexpr auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#a0cae3af55edb3eb05bfa184bda633f7d">operator!=</a> (X &amp;&amp;x, Y &amp;&amp;y)</td></tr>
  196. <tr class="memdesc:a0cae3af55edb3eb05bfa184bda633f7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code><a class="el" href="group__group-Comparable.html#gae33be2e0d5e04f19082f4b7740dfc9cd" title="Returns a Logical representing whether x is not equal to y.The not_equal function can be called in tw...">hana::not_equal</a></code> <br /></td></tr>
  197. <tr class="separator:a0cae3af55edb3eb05bfa184bda633f7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  198. <tr class="memitem:ada078dcf9e68b8e9a82b33c75dde8457"><td class="memTemplParams" colspan="2"><a id="ada078dcf9e68b8e9a82b33c75dde8457"></a>
  199. template&lt;typename X , typename Y &gt; </td></tr>
  200. <tr class="memitem:ada078dcf9e68b8e9a82b33c75dde8457"><td class="memTemplItemLeft" align="right" valign="top">constexpr auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#ada078dcf9e68b8e9a82b33c75dde8457">operator&lt;</a> (X &amp;&amp;x, Y &amp;&amp;y)</td></tr>
  201. <tr class="memdesc:ada078dcf9e68b8e9a82b33c75dde8457"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code><a class="el" href="group__group-Orderable.html#gad510011602bdb14686f1c4ec145301c9" title="Returns a Logical representing whether x is less than y.">hana::less</a></code> <br /></td></tr>
  202. <tr class="separator:ada078dcf9e68b8e9a82b33c75dde8457"><td class="memSeparator" colspan="2">&#160;</td></tr>
  203. <tr class="memitem:aedd11fddefddbbbb87d3b24c7117528f"><td class="memTemplParams" colspan="2"><a id="aedd11fddefddbbbb87d3b24c7117528f"></a>
  204. template&lt;typename X , typename Y &gt; </td></tr>
  205. <tr class="memitem:aedd11fddefddbbbb87d3b24c7117528f"><td class="memTemplItemLeft" align="right" valign="top">constexpr auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#aedd11fddefddbbbb87d3b24c7117528f">operator&gt;</a> (X &amp;&amp;x, Y &amp;&amp;y)</td></tr>
  206. <tr class="memdesc:aedd11fddefddbbbb87d3b24c7117528f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code><a class="el" href="group__group-Orderable.html#gaf9a073eafebbe514fb19dff82318f198" title="Returns a Logical representing whether x is greater than y.">hana::greater</a></code> <br /></td></tr>
  207. <tr class="separator:aedd11fddefddbbbb87d3b24c7117528f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  208. <tr class="memitem:a53817979990da799e659b2576799a79a"><td class="memTemplParams" colspan="2"><a id="a53817979990da799e659b2576799a79a"></a>
  209. template&lt;typename X , typename Y &gt; </td></tr>
  210. <tr class="memitem:a53817979990da799e659b2576799a79a"><td class="memTemplItemLeft" align="right" valign="top">constexpr auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#a53817979990da799e659b2576799a79a">operator&lt;=</a> (X &amp;&amp;x, Y &amp;&amp;y)</td></tr>
  211. <tr class="memdesc:a53817979990da799e659b2576799a79a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code><a class="el" href="group__group-Orderable.html#ga9917dd82beb67151bf5657245d37b851" title="Returns a Logical representing whether x is less than or equal to y.">hana::less_equal</a></code> <br /></td></tr>
  212. <tr class="separator:a53817979990da799e659b2576799a79a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  213. <tr class="memitem:aa3f0436b623de5208767751e1e9f7e59"><td class="memTemplParams" colspan="2"><a id="aa3f0436b623de5208767751e1e9f7e59"></a>
  214. template&lt;typename X , typename Y &gt; </td></tr>
  215. <tr class="memitem:aa3f0436b623de5208767751e1e9f7e59"><td class="memTemplItemLeft" align="right" valign="top">constexpr auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#aa3f0436b623de5208767751e1e9f7e59">operator&gt;=</a> (X &amp;&amp;x, Y &amp;&amp;y)</td></tr>
  216. <tr class="memdesc:aa3f0436b623de5208767751e1e9f7e59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code><a class="el" href="group__group-Orderable.html#ga6023631e7d0a01e16dc3fa4221fbd703" title="Returns a Logical representing whether x is greater than or equal to y.">hana::greater_equal</a></code> <br /></td></tr>
  217. <tr class="separator:aa3f0436b623de5208767751e1e9f7e59"><td class="memSeparator" colspan="2">&#160;</td></tr>
  218. </table><table class="memberdecls">
  219. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  220. Public Member Functions</h2></td></tr>
  221. <tr class="memitem:a8e10223983bfb3873c285be85f7ab273"><td class="memItemLeft" align="right" valign="top"><a id="a8e10223983bfb3873c285be85f7ab273"></a>
  222. constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#a8e10223983bfb3873c285be85f7ab273">tuple</a> ()</td></tr>
  223. <tr class="memdesc:a8e10223983bfb3873c285be85f7ab273"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructs the <code>tuple</code>. Only exists when all the elements of the tuple are default constructible. <br /></td></tr>
  224. <tr class="separator:a8e10223983bfb3873c285be85f7ab273"><td class="memSeparator" colspan="2">&#160;</td></tr>
  225. <tr class="memitem:a4e4e6193df38146b1eab93bcf963fc81"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#a4e4e6193df38146b1eab93bcf963fc81">tuple</a> (Xn const &amp;...xn)</td></tr>
  226. <tr class="memdesc:a4e4e6193df38146b1eab93bcf963fc81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize each element of the tuple with the corresponding element from <code>xn...</code>. Only exists when all the elements of the tuple are copy-constructible. <a href="#a4e4e6193df38146b1eab93bcf963fc81">More...</a><br /></td></tr>
  227. <tr class="separator:a4e4e6193df38146b1eab93bcf963fc81"><td class="memSeparator" colspan="2">&#160;</td></tr>
  228. <tr class="memitem:a9a5dd3930d94a900190de98247e0c415"><td class="memTemplParams" colspan="2">template&lt;typename ... Yn&gt; </td></tr>
  229. <tr class="memitem:a9a5dd3930d94a900190de98247e0c415"><td class="memTemplItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#a9a5dd3930d94a900190de98247e0c415">tuple</a> (Yn &amp;&amp;...yn)</td></tr>
  230. <tr class="memdesc:a9a5dd3930d94a900190de98247e0c415"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize each element of the tuple by perfect-forwarding the corresponding element in <code>yn...</code>. Only exists when all the elements of the created tuple are constructible from the corresponding perfect-forwarded value. <a href="#a9a5dd3930d94a900190de98247e0c415">More...</a><br /></td></tr>
  231. <tr class="separator:a9a5dd3930d94a900190de98247e0c415"><td class="memSeparator" colspan="2">&#160;</td></tr>
  232. <tr class="memitem:a6cf99e86ab1506594eca03881748fe91"><td class="memTemplParams" colspan="2"><a id="a6cf99e86ab1506594eca03881748fe91"></a>
  233. template&lt;typename ... Yn&gt; </td></tr>
  234. <tr class="memitem:a6cf99e86ab1506594eca03881748fe91"><td class="memTemplItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#a6cf99e86ab1506594eca03881748fe91">tuple</a> (<a class="el" href="structboost_1_1hana_1_1tuple.html">tuple</a>&lt; Yn... &gt; const &amp;other)</td></tr>
  235. <tr class="memdesc:a6cf99e86ab1506594eca03881748fe91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy-initialize a tuple from another tuple. Only exists when all the elements of the constructed tuple are copy-constructible from the corresponding element in the source tuple. <br /></td></tr>
  236. <tr class="separator:a6cf99e86ab1506594eca03881748fe91"><td class="memSeparator" colspan="2">&#160;</td></tr>
  237. <tr class="memitem:ac504757198d85ab9de1258de634e3b71"><td class="memTemplParams" colspan="2"><a id="ac504757198d85ab9de1258de634e3b71"></a>
  238. template&lt;typename ... Yn&gt; </td></tr>
  239. <tr class="memitem:ac504757198d85ab9de1258de634e3b71"><td class="memTemplItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#ac504757198d85ab9de1258de634e3b71">tuple</a> (<a class="el" href="structboost_1_1hana_1_1tuple.html">tuple</a>&lt; Yn... &gt; &amp;&amp;other)</td></tr>
  240. <tr class="memdesc:ac504757198d85ab9de1258de634e3b71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move-initialize a tuple from another tuple. Only exists when all the elements of the constructed tuple are move-constructible from the corresponding element in the source tuple. <br /></td></tr>
  241. <tr class="separator:ac504757198d85ab9de1258de634e3b71"><td class="memSeparator" colspan="2">&#160;</td></tr>
  242. <tr class="memitem:acddfa6d631c249ae667d52dd63c0aeaf"><td class="memTemplParams" colspan="2"><a id="acddfa6d631c249ae667d52dd63c0aeaf"></a>
  243. template&lt;typename ... Yn&gt; </td></tr>
  244. <tr class="memitem:acddfa6d631c249ae667d52dd63c0aeaf"><td class="memTemplItemLeft" align="right" valign="top">constexpr <a class="el" href="structboost_1_1hana_1_1tuple.html">tuple</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#acddfa6d631c249ae667d52dd63c0aeaf">operator=</a> (<a class="el" href="structboost_1_1hana_1_1tuple.html">tuple</a>&lt; Yn... &gt; const &amp;other)</td></tr>
  245. <tr class="memdesc:acddfa6d631c249ae667d52dd63c0aeaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assign a tuple to another tuple. Only exists when all the elements of the destination tuple are assignable from the corresponding element in the source tuple. <br /></td></tr>
  246. <tr class="separator:acddfa6d631c249ae667d52dd63c0aeaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  247. <tr class="memitem:ad3f0fe520974a22cc12a978f4b061caa"><td class="memTemplParams" colspan="2"><a id="ad3f0fe520974a22cc12a978f4b061caa"></a>
  248. template&lt;typename ... Yn&gt; </td></tr>
  249. <tr class="memitem:ad3f0fe520974a22cc12a978f4b061caa"><td class="memTemplItemLeft" align="right" valign="top">constexpr <a class="el" href="structboost_1_1hana_1_1tuple.html">tuple</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#ad3f0fe520974a22cc12a978f4b061caa">operator=</a> (<a class="el" href="structboost_1_1hana_1_1tuple.html">tuple</a>&lt; Yn... &gt; &amp;&amp;other)</td></tr>
  250. <tr class="memdesc:ad3f0fe520974a22cc12a978f4b061caa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move-assign a tuple to another tuple. Only exists when all the elements of the destination tuple are move-assignable from the corresponding element in the source tuple. <br /></td></tr>
  251. <tr class="separator:ad3f0fe520974a22cc12a978f4b061caa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  252. <tr class="memitem:acef38216a6c6da0296a5f7b5241e951b"><td class="memTemplParams" colspan="2"><a id="acef38216a6c6da0296a5f7b5241e951b"></a>
  253. template&lt;typename N &gt; </td></tr>
  254. <tr class="memitem:acef38216a6c6da0296a5f7b5241e951b"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto) constexpr&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1tuple.html#acef38216a6c6da0296a5f7b5241e951b">operator[]</a> (N &amp;&amp;n)</td></tr>
  255. <tr class="memdesc:acef38216a6c6da0296a5f7b5241e951b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code><a class="el" href="group__group-Iterable.html#ga8a484304380eae38f3d9663d98860129" title="Returns the nth element of an iterable.Given an Iterable and an IntegralConstant index,...">hana::at</a></code> <br /></td></tr>
  256. <tr class="separator:acef38216a6c6da0296a5f7b5241e951b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  257. </table>
  258. <h2 class="groupheader">Associated functions</h2>
  259. <a id="ad9d8c7efa77e573eba2dfc48b3343e66"></a>
  260. <h2 class="memtitle"><span class="permalink"><a href="#ad9d8c7efa77e573eba2dfc48b3343e66">&#9670;&nbsp;</a></span>make&lt; tuple_tag &gt;</h2>
  261. <div class="memitem">
  262. <div class="memproto">
  263. <div class="memtemplate">
  264. template&lt;typename ... Xn&gt; </div>
  265. <div class="memtemplate">
  266. template&lt;&gt; </div>
  267. <table class="mlabels">
  268. <tr>
  269. <td class="mlabels-left">
  270. <table class="memname">
  271. <tr>
  272. <td class="memname">constexpr auto <a class="el" href="group__group-core.html#ga1d92480f0af1029878e773dafa3e2f60">make</a>&lt; <a class="el" href="structboost_1_1hana_1_1tuple__tag.html">tuple_tag</a> &gt;</td>
  273. </tr>
  274. </table>
  275. </td>
  276. <td class="mlabels-right">
  277. <span class="mlabels"><span class="mlabel">related</span></span> </td>
  278. </tr>
  279. </table>
  280. </div><div class="memdoc">
  281. <b>Initial value:</b><div class="fragment"><div class="line">= [](<span class="keyword">auto</span>&amp;&amp; ...xs) {</div><div class="line"> <span class="keywordflow">return</span> <a class="code" href="structboost_1_1hana_1_1tuple.html#a8e10223983bfb3873c285be85f7ab273">tuple</a>&lt;std::decay_t&lt;decltype(xs)&gt;...&gt;{forwarded(xs)...};</div><div class="line"> }</div></div><!-- fragment -->
  282. <p>Function object for creating a <code>tuple</code>. </p>
  283. <p>Given zero or more objects <code>xs...</code>, <code>make&lt;<a class="el" href="structboost_1_1hana_1_1tuple__tag.html" title="Tag representing hana::tuples.">tuple_tag</a>&gt;</code> returns a new tuple containing those objects. The elements are held by value inside the resulting tuple, and they are hence copied or moved in. This is analogous to <code>std::make_tuple</code> for creating Hana tuples.</p>
  284. <h2>Example </h2>
  285. <div class="fragment"><div class="line"><span class="comment">// Copyright Louis Dionne 2013-2017</span></div><div class="line"><span class="comment">// Distributed under the Boost Software License, Version 1.0.</span></div><div class="line"><span class="comment">// (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)</span></div><div class="line"></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="assert_8hpp.html">boost/hana/assert.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="core_2make_8hpp.html">boost/hana/core/make.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="equal_8hpp.html">boost/hana/equal.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="tuple_8hpp.html">boost/hana/tuple.hpp</a>&gt;</span></div><div class="line"></div><div class="line"><span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><span class="keyword">namespace </span>hana = <a class="code" href="namespaceboost_1_1hana.html">boost::hana</a>;</div><div class="line"></div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main() {</div><div class="line"> <span class="keyword">auto</span> xs = hana::make&lt;hana::tuple_tag&gt;(1, 2, <span class="charliteral">&#39;3&#39;</span>, std::string{<span class="stringliteral">&quot;456&quot;</span>});</div><div class="line"></div><div class="line"> constexpr <span class="keyword">auto</span> ys = hana::make&lt;hana::tuple_tag&gt;(1, <span class="charliteral">&#39;2&#39;</span>, 3.456);</div><div class="line"> static_assert(ys == hana::make_tuple(1, <span class="charliteral">&#39;2&#39;</span>, 3.456), <span class="stringliteral">&quot;&quot;</span>);</div><div class="line">}</div></div><!-- fragment -->
  286. </div>
  287. </div>
  288. <a id="af3c175cfb83276339f91e867d738a2e6"></a>
  289. <h2 class="memtitle"><span class="permalink"><a href="#af3c175cfb83276339f91e867d738a2e6">&#9670;&nbsp;</a></span>make_tuple</h2>
  290. <div class="memitem">
  291. <div class="memproto">
  292. <div class="memtemplate">
  293. template&lt;typename ... Xn&gt; </div>
  294. <table class="mlabels">
  295. <tr>
  296. <td class="mlabels-left">
  297. <table class="memname">
  298. <tr>
  299. <td class="memname">constexpr auto make_tuple = <a class="el" href="group__group-core.html#ga1d92480f0af1029878e773dafa3e2f60">make</a>&lt;<a class="el" href="structboost_1_1hana_1_1tuple__tag.html">tuple_tag</a>&gt;</td>
  300. </tr>
  301. </table>
  302. </td>
  303. <td class="mlabels-right">
  304. <span class="mlabels"><span class="mlabel">related</span></span> </td>
  305. </tr>
  306. </table>
  307. </div><div class="memdoc">
  308. <p>Alias to <code>make&lt;<a class="el" href="structboost_1_1hana_1_1tuple__tag.html" title="Tag representing hana::tuples.">tuple_tag</a>&gt;</code>; provided for convenience. </p>
  309. </div>
  310. </div>
  311. <a id="a749b564c8f115957837761d75191beac"></a>
  312. <h2 class="memtitle"><span class="permalink"><a href="#a749b564c8f115957837761d75191beac">&#9670;&nbsp;</a></span>to_tuple</h2>
  313. <div class="memitem">
  314. <div class="memproto">
  315. <div class="memtemplate">
  316. template&lt;typename ... Xn&gt; </div>
  317. <table class="mlabels">
  318. <tr>
  319. <td class="mlabels-left">
  320. <table class="memname">
  321. <tr>
  322. <td class="memname">constexpr auto to_tuple = <a class="el" href="group__group-core.html#gadc70755c1d059139297814fb3bfeb91e">to</a>&lt;<a class="el" href="structboost_1_1hana_1_1tuple__tag.html">tuple_tag</a>&gt;</td>
  323. </tr>
  324. </table>
  325. </td>
  326. <td class="mlabels-right">
  327. <span class="mlabels"><span class="mlabel">related</span></span> </td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. <p>Equivalent to <code>to&lt;<a class="el" href="structboost_1_1hana_1_1tuple__tag.html" title="Tag representing hana::tuples.">tuple_tag</a>&gt;</code>; provided for convenience. </p>
  332. </div>
  333. </div>
  334. <a id="a1997546daf58a48cc15498d338a03da3"></a>
  335. <h2 class="memtitle"><span class="permalink"><a href="#a1997546daf58a48cc15498d338a03da3">&#9670;&nbsp;</a></span>tuple_t</h2>
  336. <div class="memitem">
  337. <div class="memproto">
  338. <div class="memtemplate">
  339. template&lt;typename ... Xn&gt; </div>
  340. <div class="memtemplate">
  341. template&lt;typename ... T&gt; </div>
  342. <table class="mlabels">
  343. <tr>
  344. <td class="mlabels-left">
  345. <table class="memname">
  346. <tr>
  347. <td class="memname">constexpr implementation_defined tuple_t {}</td>
  348. </tr>
  349. </table>
  350. </td>
  351. <td class="mlabels-right">
  352. <span class="mlabels"><span class="mlabel">related</span></span> </td>
  353. </tr>
  354. </table>
  355. </div><div class="memdoc">
  356. <p>Create a tuple specialized for holding <code><a class="el" href="structboost_1_1hana_1_1type.html" title="C++ type in value-level representation.">hana::type</a></code>s. </p>
  357. <p>This is functionally equivalent to <code>make&lt;<a class="el" href="structboost_1_1hana_1_1tuple__tag.html" title="Tag representing hana::tuples.">tuple_tag</a>&gt;(type_c&lt;T&gt;...)</code>, except that using <code>tuple_t</code> allows the library to perform some compile-time optimizations. Also note that the type of the objects returned by <code>tuple_t</code> and an equivalent call to <code>make&lt;<a class="el" href="structboost_1_1hana_1_1tuple__tag.html" title="Tag representing hana::tuples.">tuple_tag</a>&gt;</code> may differ.</p>
  358. <h2>Example </h2>
  359. <div class="fragment"><div class="line"><span class="comment">// Copyright Louis Dionne 2013-2017</span></div><div class="line"><span class="comment">// Distributed under the Boost Software License, Version 1.0.</span></div><div class="line"><span class="comment">// (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)</span></div><div class="line"></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="assert_8hpp.html">boost/hana/assert.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="core_2to_8hpp.html">boost/hana/core/to.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="equal_8hpp.html">boost/hana/equal.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="tuple_8hpp.html">boost/hana/tuple.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="type_8hpp.html">boost/hana/type.hpp</a>&gt;</span></div><div class="line"><span class="keyword">namespace </span>hana = <a class="code" href="namespaceboost_1_1hana.html">boost::hana</a>;</div><div class="line"></div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main() {</div><div class="line"> <a class="code" href="group__group-assertions.html#ga2c5006540936d9f8880e3a39f4fcc035">BOOST_HANA_CONSTANT_CHECK</a>(</div><div class="line"> hana::to_tuple(hana::tuple_t&lt;<span class="keywordtype">int</span>, <span class="keywordtype">char</span>, <span class="keywordtype">void</span>, <span class="keywordtype">int</span>(<span class="keywordtype">float</span>)&gt;)</div><div class="line"> ==</div><div class="line"> hana::make_tuple(hana::type_c&lt;int&gt;, hana::type_c&lt;char&gt;, hana::type_c&lt;void&gt;, hana::type_c&lt;<span class="keywordtype">int</span>(<span class="keywordtype">float</span>)&gt;)</div><div class="line"> );</div><div class="line">}</div></div><!-- fragment -->
  360. </div>
  361. </div>
  362. <a id="a85c2f16caa2a1e12eefd1b3f69fa658e"></a>
  363. <h2 class="memtitle"><span class="permalink"><a href="#a85c2f16caa2a1e12eefd1b3f69fa658e">&#9670;&nbsp;</a></span>tuple_c</h2>
  364. <div class="memitem">
  365. <div class="memproto">
  366. <div class="memtemplate">
  367. template&lt;typename ... Xn&gt; </div>
  368. <div class="memtemplate">
  369. template&lt;typename T , T ... v&gt; </div>
  370. <table class="mlabels">
  371. <tr>
  372. <td class="mlabels-left">
  373. <table class="memname">
  374. <tr>
  375. <td class="memname">constexpr implementation_defined tuple_c {}</td>
  376. </tr>
  377. </table>
  378. </td>
  379. <td class="mlabels-right">
  380. <span class="mlabels"><span class="mlabel">related</span></span> </td>
  381. </tr>
  382. </table>
  383. </div><div class="memdoc">
  384. <p>Create a tuple specialized for holding <code><a class="el" href="structboost_1_1hana_1_1integral__constant.html" title="Compile-time value of an integral type.">hana::integral_constant</a></code>s. </p>
  385. <p>This is functionally equivalent to <code>make&lt;<a class="el" href="structboost_1_1hana_1_1tuple__tag.html" title="Tag representing hana::tuples.">tuple_tag</a>&gt;(integral_c&lt;T, v&gt;...)</code>, except that using <code>tuple_c</code> allows the library to perform some compile-time optimizations. Also note that the type of the objects returned by <code>tuple_c</code> and an equivalent call to <code>make&lt;<a class="el" href="structboost_1_1hana_1_1tuple__tag.html" title="Tag representing hana::tuples.">tuple_tag</a>&gt;</code> may differ.</p>
  386. <h2>Example </h2>
  387. <div class="fragment"><div class="line"><span class="comment">// Copyright Louis Dionne 2013-2017</span></div><div class="line"><span class="comment">// Distributed under the Boost Software License, Version 1.0.</span></div><div class="line"><span class="comment">// (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)</span></div><div class="line"></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="assert_8hpp.html">boost/hana/assert.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="core_2to_8hpp.html">boost/hana/core/to.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="equal_8hpp.html">boost/hana/equal.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="front_8hpp.html">boost/hana/front.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="integral__constant_8hpp.html">boost/hana/integral_constant.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="tuple_8hpp.html">boost/hana/tuple.hpp</a>&gt;</span></div><div class="line"><span class="keyword">namespace </span>hana = <a class="code" href="namespaceboost_1_1hana.html">boost::hana</a>;</div><div class="line"></div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main() {</div><div class="line"> <a class="code" href="group__group-assertions.html#ga2c5006540936d9f8880e3a39f4fcc035">BOOST_HANA_CONSTANT_CHECK</a>(</div><div class="line"> hana::tuple_c&lt;int, 0, 1, 2&gt;</div><div class="line"> ==</div><div class="line"> hana::make_tuple(hana::int_c&lt;0&gt;, hana::int_c&lt;1&gt;, hana::int_c&lt;2&gt;)</div><div class="line"> );</div><div class="line"></div><div class="line"> <a class="code" href="group__group-assertions.html#ga2c5006540936d9f8880e3a39f4fcc035">BOOST_HANA_CONSTANT_CHECK</a>(<a class="code" href="group__group-Iterable.html#ga8a67ea10e8082dbe6705e573fa978444">hana::front</a>(hana::tuple_c&lt;int, 0, 1, 2&gt;) == hana::int_c&lt;0&gt;);</div><div class="line">}</div></div><!-- fragment -->
  388. </div>
  389. </div>
  390. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  391. <a id="a4e4e6193df38146b1eab93bcf963fc81"></a>
  392. <h2 class="memtitle"><span class="permalink"><a href="#a4e4e6193df38146b1eab93bcf963fc81">&#9670;&nbsp;</a></span>tuple() <span class="overload">[1/2]</span></h2>
  393. <div class="memitem">
  394. <div class="memproto">
  395. <div class="memtemplate">
  396. template&lt;typename ... Xn&gt; </div>
  397. <table class="memname">
  398. <tr>
  399. <td class="memname">constexpr <a class="el" href="structboost_1_1hana_1_1tuple.html">boost::hana::tuple</a>&lt; Xn &gt;::<a class="el" href="structboost_1_1hana_1_1tuple.html">tuple</a> </td>
  400. <td>(</td>
  401. <td class="paramtype">Xn const &amp;...&#160;</td>
  402. <td class="paramname"><em>xn</em></td><td>)</td>
  403. <td></td>
  404. </tr>
  405. </table>
  406. </div><div class="memdoc">
  407. <p>Initialize each element of the tuple with the corresponding element from <code>xn...</code>. Only exists when all the elements of the tuple are copy-constructible. </p>
  408. <dl class="section note"><dt>Note</dt><dd>Unlike the corresponding constructor for <code><a class="el" href="structstd_1_1tuple.html" title="Adapter for std::tuples.">std::tuple</a></code>, this constructor is not explicit. This allows returning a tuple from a function with the brace-initialization syntax. </dd></dl>
  409. </div>
  410. </div>
  411. <a id="a9a5dd3930d94a900190de98247e0c415"></a>
  412. <h2 class="memtitle"><span class="permalink"><a href="#a9a5dd3930d94a900190de98247e0c415">&#9670;&nbsp;</a></span>tuple() <span class="overload">[2/2]</span></h2>
  413. <div class="memitem">
  414. <div class="memproto">
  415. <div class="memtemplate">
  416. template&lt;typename ... Xn&gt; </div>
  417. <div class="memtemplate">
  418. template&lt;typename ... Yn&gt; </div>
  419. <table class="memname">
  420. <tr>
  421. <td class="memname">constexpr <a class="el" href="structboost_1_1hana_1_1tuple.html">boost::hana::tuple</a>&lt; Xn &gt;::<a class="el" href="structboost_1_1hana_1_1tuple.html">tuple</a> </td>
  422. <td>(</td>
  423. <td class="paramtype">Yn &amp;&amp;...&#160;</td>
  424. <td class="paramname"><em>yn</em></td><td>)</td>
  425. <td></td>
  426. </tr>
  427. </table>
  428. </div><div class="memdoc">
  429. <p>Initialize each element of the tuple by perfect-forwarding the corresponding element in <code>yn...</code>. Only exists when all the elements of the created tuple are constructible from the corresponding perfect-forwarded value. </p>
  430. <dl class="section note"><dt>Note</dt><dd>Unlike the corresponding constructor for <code><a class="el" href="structstd_1_1tuple.html" title="Adapter for std::tuples.">std::tuple</a></code>, this constructor is not explicit. This allows returning a tuple from a function with the brace-initialization syntax. </dd></dl>
  431. </div>
  432. </div>
  433. </div><!-- contents -->
  434. </div><!-- doc-content -->
  435. <!--
  436. Copyright Louis Dionne 2013-2017
  437. Distributed under the Boost Software License, Version 1.0.
  438. (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)
  439. -->
  440. <!-- boost-no-inspect -->
  441. <!-- HTML footer for doxygen 1.8.9.1-->
  442. <!-- start footer part -->
  443. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  444. <ul>
  445. <li class="navelem"><b>boost</b></li><li class="navelem"><a class="el" href="namespaceboost_1_1hana.html">hana</a></li><li class="navelem"><a class="el" href="structboost_1_1hana_1_1tuple.html">tuple</a></li>
  446. </ul>
  447. </div>
  448. </body>
  449. </html>