structboost_1_1hana_1_1basic__tuple.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231
  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::basic_tuple&lt; Xs &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_1basic__tuple.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="structboost_1_1hana_1_1basic__tuple-members.html">List of all members</a> </div>
  131. <div class="headertitle">
  132. <div class="title">boost::hana::basic_tuple&lt; Xs &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group__group-datatypes.html">Data types</a></div></div> </div>
  133. </div><!--header-->
  134. <div class="contents">
  135. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  136. <div class="textblock"><h3>template&lt;typename ... Xs&gt;<br />
  137. struct boost::hana::basic_tuple&lt; Xs &gt;</h3>
  138. <p>Stripped down version of <code><a class="el" href="structboost_1_1hana_1_1tuple.html" title="General purpose index-based heterogeneous sequence with a fixed length.">hana::tuple</a></code>. </p>
  139. <p>Whereas <code><a class="el" href="structboost_1_1hana_1_1tuple.html" title="General purpose index-based heterogeneous sequence with a fixed length.">hana::tuple</a></code> aims to provide an interface somewhat close to a <code><a class="el" href="structstd_1_1tuple.html" title="Adapter for std::tuples.">std::tuple</a></code>, <code><a class="el" href="structboost_1_1hana_1_1basic__tuple.html" title="Stripped down version of hana::tuple.">basic_tuple</a></code> provides the strict minimum required to implement a closure with maximum compile-time efficiency.</p>
  140. <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>
  141. <h2>Modeled concepts </h2>
  142. <p><code>Sequence</code>, and all the concepts it refines </p>
  143. </div><table class="memberdecls">
  144. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
  145. Synopsis of associated functions</h2></td></tr>
  146. <tr class="memitem:a53975be786ae1db16185edab229547cd"><td class="memTemplParams" colspan="2">template&lt;&gt; </td></tr>
  147. <tr class="memitem:a53975be786ae1db16185edab229547cd"><td class="memTemplItemLeft" align="right" valign="top">constexpr auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1basic__tuple.html#a53975be786ae1db16185edab229547cd">make&lt; basic_tuple_tag &gt;</a></td></tr>
  148. <tr class="memdesc:a53975be786ae1db16185edab229547cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function object for creating a <code><a class="el" href="structboost_1_1hana_1_1basic__tuple.html" title="Stripped down version of hana::tuple.">basic_tuple</a></code>. <a href="#a53975be786ae1db16185edab229547cd">More...</a><br /></td></tr>
  149. <tr class="separator:a53975be786ae1db16185edab229547cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:afe2c3fc2808e83353b7274dddd662c7e"><td class="memItemLeft" align="right" valign="top">constexpr auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1hana_1_1basic__tuple.html#afe2c3fc2808e83353b7274dddd662c7e">make_basic_tuple</a> = <a class="el" href="group__group-core.html#ga1d92480f0af1029878e773dafa3e2f60">make</a>&lt;<a class="el" href="structboost_1_1hana_1_1basic__tuple__tag.html">basic_tuple_tag</a>&gt;</td></tr>
  151. <tr class="memdesc:afe2c3fc2808e83353b7274dddd662c7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias to <code>make&lt;<a class="el" href="structboost_1_1hana_1_1basic__tuple__tag.html" title="Tag representing hana::basic_tuple.">basic_tuple_tag</a>&gt;</code>; provided for convenience. <a href="#afe2c3fc2808e83353b7274dddd662c7e">More...</a><br /></td></tr>
  152. <tr class="separator:afe2c3fc2808e83353b7274dddd662c7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. </table>
  154. <h2 class="groupheader">Associated functions</h2>
  155. <a id="a53975be786ae1db16185edab229547cd"></a>
  156. <h2 class="memtitle"><span class="permalink"><a href="#a53975be786ae1db16185edab229547cd">&#9670;&nbsp;</a></span>make&lt; basic_tuple_tag &gt;</h2>
  157. <div class="memitem">
  158. <div class="memproto">
  159. <div class="memtemplate">
  160. template&lt;typename ... Xs&gt; </div>
  161. <div class="memtemplate">
  162. template&lt;&gt; </div>
  163. <table class="mlabels">
  164. <tr>
  165. <td class="mlabels-left">
  166. <table class="memname">
  167. <tr>
  168. <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_1basic__tuple__tag.html">basic_tuple_tag</a> &gt;</td>
  169. </tr>
  170. </table>
  171. </td>
  172. <td class="mlabels-right">
  173. <span class="mlabels"><span class="mlabel">related</span></span> </td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. <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> basic_tuple&lt;std::decay_t&lt;decltype(xs)&gt;...&gt;{forwarded(xs)...};</div><div class="line"> }</div></div><!-- fragment -->
  178. <p>Function object for creating a <code><a class="el" href="structboost_1_1hana_1_1basic__tuple.html" title="Stripped down version of hana::tuple.">basic_tuple</a></code>. </p>
  179. <p>Given zero or more objects <code>xs...</code>, <code>make&lt;<a class="el" href="structboost_1_1hana_1_1basic__tuple__tag.html" title="Tag representing hana::basic_tuple.">basic_tuple_tag</a>&gt;</code> returns a new <code><a class="el" href="structboost_1_1hana_1_1basic__tuple.html" title="Stripped down version of hana::tuple.">basic_tuple</a></code> 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 <code><a class="el" href="structboost_1_1hana_1_1basic__tuple.html" title="Stripped down version of hana::tuple.">basic_tuple</a></code>s.</p>
  180. <h2>Example </h2>
  181. <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="basic__tuple_8hpp.html">boost/hana/basic_tuple.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"></div><div class="line"><span class="preprocessor">#include &lt;type_traits&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">constexpr hana::basic_tuple&lt;int, char, double&gt; xs{1, <span class="charliteral">&#39;2&#39;</span>, 3.3};</div><div class="line">constexpr <span class="keyword">auto</span> ys = hana::make&lt;hana::basic_tuple_tag&gt;(1, <span class="charliteral">&#39;2&#39;</span>, 3.3);</div><div class="line">constexpr <span class="keyword">auto</span> zs = hana::make_basic_tuple(1, <span class="charliteral">&#39;2&#39;</span>, 3.3);</div><div class="line"></div><div class="line">static_assert(std::is_same&lt;decltype(ys), decltype(xs)&gt;::<a class="code" href="group__group-Constant.html#ga1687520692a6b0c49e3a69de2980f388">value</a>, <span class="stringliteral">&quot;&quot;</span>);</div><div class="line">static_assert(std::is_same&lt;decltype(zs), decltype(xs)&gt;::<a class="code" href="group__group-Constant.html#ga1687520692a6b0c49e3a69de2980f388">value</a>, <span class="stringliteral">&quot;&quot;</span>);</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main() { }</div></div><!-- fragment -->
  182. </div>
  183. </div>
  184. <a id="afe2c3fc2808e83353b7274dddd662c7e"></a>
  185. <h2 class="memtitle"><span class="permalink"><a href="#afe2c3fc2808e83353b7274dddd662c7e">&#9670;&nbsp;</a></span>make_basic_tuple</h2>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <div class="memtemplate">
  189. template&lt;typename ... Xs&gt; </div>
  190. <table class="mlabels">
  191. <tr>
  192. <td class="mlabels-left">
  193. <table class="memname">
  194. <tr>
  195. <td class="memname">constexpr auto make_basic_tuple = <a class="el" href="group__group-core.html#ga1d92480f0af1029878e773dafa3e2f60">make</a>&lt;<a class="el" href="structboost_1_1hana_1_1basic__tuple__tag.html">basic_tuple_tag</a>&gt;</td>
  196. </tr>
  197. </table>
  198. </td>
  199. <td class="mlabels-right">
  200. <span class="mlabels"><span class="mlabel">related</span></span> </td>
  201. </tr>
  202. </table>
  203. </div><div class="memdoc">
  204. <p>Alias to <code>make&lt;<a class="el" href="structboost_1_1hana_1_1basic__tuple__tag.html" title="Tag representing hana::basic_tuple.">basic_tuple_tag</a>&gt;</code>; provided for convenience. </p>
  205. <h2>Example </h2>
  206. <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="basic__tuple_8hpp.html">boost/hana/basic_tuple.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"></div><div class="line"><span class="preprocessor">#include &lt;type_traits&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">constexpr hana::basic_tuple&lt;int, char, double&gt; xs{1, <span class="charliteral">&#39;2&#39;</span>, 3.3};</div><div class="line">constexpr <span class="keyword">auto</span> ys = hana::make&lt;hana::basic_tuple_tag&gt;(1, <span class="charliteral">&#39;2&#39;</span>, 3.3);</div><div class="line">constexpr <span class="keyword">auto</span> zs = hana::make_basic_tuple(1, <span class="charliteral">&#39;2&#39;</span>, 3.3);</div><div class="line"></div><div class="line">static_assert(std::is_same&lt;decltype(ys), decltype(xs)&gt;::<a class="code" href="group__group-Constant.html#ga1687520692a6b0c49e3a69de2980f388">value</a>, <span class="stringliteral">&quot;&quot;</span>);</div><div class="line">static_assert(std::is_same&lt;decltype(zs), decltype(xs)&gt;::<a class="code" href="group__group-Constant.html#ga1687520692a6b0c49e3a69de2980f388">value</a>, <span class="stringliteral">&quot;&quot;</span>);</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main() { }</div></div><!-- fragment -->
  207. </div>
  208. </div>
  209. </div><!-- contents -->
  210. </div><!-- doc-content -->
  211. <!--
  212. Copyright Louis Dionne 2013-2017
  213. Distributed under the Boost Software License, Version 1.0.
  214. (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)
  215. -->
  216. <!-- boost-no-inspect -->
  217. <!-- HTML footer for doxygen 1.8.9.1-->
  218. <!-- start footer part -->
  219. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  220. <ul>
  221. <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_1basic__tuple.html">basic_tuple</a></li>
  222. </ul>
  223. </div>
  224. </body>
  225. </html>