apply-wrap.html 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
  7. <title>The MPL Reference Manual: apply_wrap</title>
  8. <link rel="stylesheet" href="../style.css" type="text/css" />
  9. </head>
  10. <body class="docframe refmanual">
  11. <table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./apply.html" class="navigation-link">Prev</a>&nbsp;<a href="./unpack-args.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./apply.html" class="navigation-link">Back</a>&nbsp;<a href="./unpack-args.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./invocation.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
  12. <td class="header-group page-location"><a href="../refmanual.html" class="navigation-link">Front Page</a> / <a href="./metafunctions.html" class="navigation-link">Metafunctions</a> / <a href="./invocation.html" class="navigation-link">Invocation</a> / <a href="./apply-wrap.html" class="navigation-link">apply_wrap</a></td>
  13. </tr></table><div class="header-separator"></div>
  14. <div class="section" id="apply-wrap">
  15. <h1><a class="toc-backref" href="./invocation.html#id1526">apply_wrap</a></h1>
  16. <div class="section" id="id894">
  17. <h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
  18. <pre class="literal-block">
  19. template&lt;
  20. typename F
  21. &gt;
  22. struct apply_wrap0
  23. {
  24. typedef <em>unspecified</em> type;
  25. };
  26. template&lt;
  27. typename F, typename A1
  28. &gt;
  29. struct apply_wrap1
  30. {
  31. typedef <em>unspecified</em> type;
  32. };
  33. <em>...</em>
  34. template&lt;
  35. typename F, typename A1,<em>...</em> typename An
  36. &gt;
  37. struct <a href="./apply-wrap.html" class="identifier">apply_wrap</a><em>n</em>
  38. {
  39. typedef <em>unspecified</em> type;
  40. };
  41. </pre>
  42. </div>
  43. <div class="section" id="id895">
  44. <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  45. <p>Invokes a <a class="reference internal" href="./metafunction-class.html">Metafunction Class</a> <tt class="literal"><span class="pre">F</span></tt> with arguments <tt class="literal"><span class="pre">A1</span></tt>,... <tt class="literal"><span class="pre">An</span></tt>.</p>
  46. <p>In essence, <tt class="literal"><span class="pre"><a href="./apply-wrap.html" class="identifier">apply_wrap</a></span></tt> forms are nothing more than syntactic wrappers around
  47. <tt class="literal"><span class="pre">F::<a href="./apply.html" class="identifier">apply</a>&lt;A1,...</span> <span class="pre">An&gt;::type</span></tt> / <tt class="literal"><span class="pre">F::<a href="./apply.html" class="identifier">apply</a>::type</span></tt> expressions (hence the name).
  48. They provide a more concise notation and higher portability than their
  49. underlaying constructs at the cost of an extra template instantiation.</p>
  50. </div>
  51. <div class="section" id="id896">
  52. <h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
  53. <pre class="literal-block">
  54. #include &lt;<a href="../../../../boost/mpl/apply_wrap.hpp" class="header">boost/mpl/apply_wrap.hpp</a>&gt;
  55. </pre>
  56. </div>
  57. <div class="section" id="id897">
  58. <h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
  59. <table border="1" class="docutils table">
  60. <colgroup>
  61. <col width="15%" />
  62. <col width="36%" />
  63. <col width="48%" />
  64. </colgroup>
  65. <thead valign="bottom">
  66. <tr><th class="head">Parameter</th>
  67. <th class="head">Requirement</th>
  68. <th class="head">Description</th>
  69. </tr>
  70. </thead>
  71. <tbody valign="top">
  72. <tr><td><tt class="literal"><span class="pre">F</span></tt></td>
  73. <td><a class="reference internal" href="./metafunction-class.html">Metafunction Class</a></td>
  74. <td>A metafunction class to invoke.</td>
  75. </tr>
  76. <tr><td><tt class="literal"><span class="pre">A1</span></tt>,... <tt class="literal"><span class="pre">An</span></tt></td>
  77. <td>Any type</td>
  78. <td>Invocation arguments.</td>
  79. </tr>
  80. </tbody>
  81. </table>
  82. </div>
  83. <div class="section" id="id898">
  84. <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
  85. <p>For any <a class="reference internal" href="./metafunction-class.html">Metafunction Class</a> <tt class="literal"><span class="pre">f</span></tt> and arbitrary types <tt class="literal"><span class="pre">a1</span></tt>,... <tt class="literal"><span class="pre">an</span></tt>:</p>
  86. <pre class="literal-block">
  87. typedef <a href="./apply-wrap.html" class="identifier">apply_wrap</a><em>n</em>&lt;f,a1,<em>...</em>an&gt;::type t;
  88. </pre>
  89. <table class="docutils field-list" frame="void" rules="none">
  90. <col class="field-name" />
  91. <col class="field-body" />
  92. <tbody valign="top">
  93. <tr class="field"><th class="field-name">Return type:</th><td class="field-body">Any type.</td>
  94. </tr>
  95. <tr class="field"><th class="field-name">Semantics:</th><td class="field-body">If <tt class="literal"><span class="pre">n</span> <span class="pre">&gt;</span> <span class="pre">0</span></tt>, equivalent to <tt class="literal"><span class="pre">typedef</span> <span class="pre">f::<a href="./apply.html" class="identifier">apply</a>&lt;a1,...</span> <span class="pre">an&gt;::type</span> <span class="pre">t;</span></tt>,
  96. otherwise equivalent to either <tt class="literal"><span class="pre">typedef</span> <span class="pre">f::<a href="./apply.html" class="identifier">apply</a>::type</span> <span class="pre">t;</span></tt> or
  97. <tt class="literal"><span class="pre">typedef</span> <span class="pre">f::<a href="./apply.html" class="identifier">apply</a>&lt;&gt;::type</span> <span class="pre">t;</span></tt> depending on whether <tt class="literal"><span class="pre">f::<a href="./apply.html" class="identifier">apply</a></span></tt> is
  98. a class or a class template.</td>
  99. </tr>
  100. </tbody>
  101. </table>
  102. </div>
  103. <div class="section" id="id899">
  104. <h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
  105. <pre class="literal-block">
  106. struct f0
  107. {
  108. template&lt; typename T = int &gt; struct <a href="./apply.html" class="identifier">apply</a>
  109. {
  110. typedef char type;
  111. };
  112. };
  113. struct g0
  114. {
  115. struct <a href="./apply.html" class="identifier">apply</a> { typedef char type; };
  116. };
  117. struct f2
  118. {
  119. template&lt; typename T1, typename T2 &gt; struct <a href="./apply.html" class="identifier">apply</a>
  120. {
  121. typedef T2 type;
  122. };
  123. };
  124. typedef <a href="./apply-wrap.html" class="identifier">apply_wrap</a><tt class="literal"><span class="pre">0</span></tt>&lt; f0 &gt;::type r1;
  125. typedef <a href="./apply-wrap.html" class="identifier">apply_wrap</a><tt class="literal"><span class="pre">0</span></tt>&lt; g0 &gt;::type r2;
  126. typedef <a href="./apply-wrap.html" class="identifier">apply_wrap</a><tt class="literal"><span class="pre">2</span></tt>&lt; f2,int,char &gt;::type r3;
  127. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt;r1,char&gt; ));
  128. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt;r2,char&gt; ));
  129. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt;r3,char&gt; ));
  130. </pre>
  131. </div>
  132. <div class="section" id="id900">
  133. <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
  134. <p><a class="reference internal" href="./metafunctions.html">Metafunctions</a>, <a class="reference internal" href="./invocation.html">invocation</a>, <a class="reference internal" href="./apply.html">apply</a>, <a class="reference internal" href="./lambda.html">lambda</a>, <a class="reference internal" href="./quote.html">quote</a>, <a class="reference internal" href="./bind.html">bind</a>, <a class="reference internal" href="./protect.html">protect</a></p>
  135. <!-- Metafunctions/Invocation//unpack_args |30 -->
  136. </div>
  137. </div>
  138. <div class="footer-separator"></div>
  139. <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./apply.html" class="navigation-link">Prev</a>&nbsp;<a href="./unpack-args.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./apply.html" class="navigation-link">Back</a>&nbsp;<a href="./unpack-args.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./invocation.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
  140. <td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div>
  141. Distributed under the Boost Software License, Version 1.0. (See accompanying
  142. file LICENSE_1_0.txt or copy at <a class="reference external" href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</div></td></tr></table></body>
  143. </html>