bind.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
  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: bind</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="./lambda.html" class="navigation-link">Prev</a>&nbsp;<a href="./quote.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./lambda.html" class="navigation-link">Back</a>&nbsp;<a href="./quote.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./composition-and-argument-binding.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="./composition-and-argument-binding.html" class="navigation-link">Composition and Argument Binding</a> / <a href="./bind.html" class="navigation-link">bind</a></td>
  13. </tr></table><div class="header-separator"></div>
  14. <div class="section" id="bind">
  15. <h1><a class="toc-backref" href="./composition-and-argument-binding.html#id1531">bind</a></h1>
  16. <div class="section" id="id929">
  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 bind0
  23. {
  24. // <em>unspecified</em>
  25. // <em>...</em>
  26. };
  27. template&lt;
  28. typename F, typename A1
  29. &gt;
  30. struct bind1
  31. {
  32. // <em>unspecified</em>
  33. // <em>...</em>
  34. };
  35. <em>...</em>
  36. template&lt;
  37. typename F, typename A1,<em>...</em> typename An
  38. &gt;
  39. struct <a href="./bind.html" class="identifier">bind</a><em>n</em>
  40. {
  41. // <em>unspecified</em>
  42. // <em>...</em>
  43. };
  44. template&lt;
  45. typename F
  46. , typename A1 = <em>unspecified</em>
  47. <em>...</em>
  48. , typename An = <em>unspecified</em>
  49. &gt;
  50. struct <a href="./bind.html" class="identifier">bind</a>
  51. {
  52. // <em>unspecified</em>
  53. // <em>...</em>
  54. };
  55. </pre>
  56. </div>
  57. <div class="section" id="id930">
  58. <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  59. <p><tt class="literal"><span class="pre"><a href="./bind.html" class="identifier">bind</a></span></tt> is a higher-order primitive for <a class="reference internal" href="./metafunction-class.html">Metafunction Class</a> composition
  60. and argument binding. In essence, it's a compile-time counterpart of
  61. the similar run-time functionality provided by <a class="reference external" href="http://www.boost.org/libs/bind/bind.html" target="_top">Boost.Bind</a> and <a class="reference external" href="http://www.boost.org/libs/lambda/doc/index.html" target="_top">Boost.Lambda</a>
  62. libraries.</p>
  63. </div>
  64. <div class="section" id="id931">
  65. <h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
  66. <pre class="literal-block">
  67. #include &lt;<a href="../../../../boost/mpl/bind.hpp" class="header">boost/mpl/bind.hpp</a>&gt;
  68. </pre>
  69. </div>
  70. <div class="section" id="id932">
  71. <h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
  72. <p><a class="reference internal" href="./metafunction-class.html">Metafunction Class</a></p>
  73. </div>
  74. <div class="section" id="id933">
  75. <h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
  76. <table border="1" class="docutils table">
  77. <colgroup>
  78. <col width="15%" />
  79. <col width="36%" />
  80. <col width="48%" />
  81. </colgroup>
  82. <thead valign="bottom">
  83. <tr><th class="head">Parameter</th>
  84. <th class="head">Requirement</th>
  85. <th class="head">Description</th>
  86. </tr>
  87. </thead>
  88. <tbody valign="top">
  89. <tr><td><tt class="literal"><span class="pre">F</span></tt></td>
  90. <td><a class="reference internal" href="./metafunction-class.html">Metafunction Class</a></td>
  91. <td>An metafunction class to perform binding on.</td>
  92. </tr>
  93. <tr><td><tt class="literal"><span class="pre">A1</span></tt>,... <tt class="literal"><span class="pre">An</span></tt></td>
  94. <td>Any type</td>
  95. <td>Arguments to bind.</td>
  96. </tr>
  97. </tbody>
  98. </table>
  99. </div>
  100. <div class="section" id="id934">
  101. <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
  102. <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>
  103. <pre class="literal-block">
  104. typedef <a href="./bind.html" class="identifier">bind</a>&lt;f,a1,...a<em>n</em>&gt; g;
  105. typedef <a href="./bind.html" class="identifier">bind</a><em>n</em>&lt;f,a1,...a<em>n</em>&gt; g;
  106. </pre>
  107. <table class="docutils field-list" frame="void" rules="none">
  108. <col class="field-name" />
  109. <col class="field-body" />
  110. <tbody valign="top">
  111. <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="./metafunction-class.html">Metafunction Class</a></td>
  112. </tr>
  113. </tbody>
  114. </table>
  115. <table class="docutils field-list" frame="void" id="bind-semantics" rules="none">
  116. <col class="field-name" />
  117. <col class="field-body" />
  118. <tbody valign="top">
  119. <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
  120. <pre class="literal-block">
  121. struct g
  122. {
  123. template&lt;
  124. typename U1 = <em>unspecified</em>
  125. <em>...</em>
  126. , typename U<em>n</em> = <em>unspecified</em>
  127. &gt;
  128. struct <a href="./apply.html" class="identifier">apply</a>
  129. : <a href="./apply-wrap.html" class="identifier">apply_wrap</a><em>n</em>&lt;
  130. typename h0&lt;f,U1,<em>...</em>U<em>n</em>&gt;::type
  131. , typename h1&lt;a1,U1,<em>...</em>U<em>n</em>&gt;::type
  132. <em>...</em>
  133. , typename h<em>n</em>&lt;a<em>n</em>,U1,<em>...</em>U<em>n</em>&gt;::type
  134. >
  135. {
  136. };
  137. };
  138. </pre>
  139. <p>where <tt class="literal"><span class="pre">h</span></tt><em>k</em> is equivalent to</p>
  140. <pre class="literal-block">
  141. template&lt; typename X, typename U1,<em>...</em> typename U<em>n</em> &gt; struct h<em>k</em>
  142. : <a href="./apply-wrap.html" class="identifier">apply_wrap</a><em>n</em>&lt;X,U1,<em>...</em>U<em>n</em>&gt;
  143. {
  144. };
  145. </pre>
  146. <p>if <tt class="literal"><span class="pre">f</span></tt> or <tt class="literal"><span class="pre">a</span></tt><em>k</em> is a <a class="reference internal" href="./terminology.html#bind-expression">bind expression</a> or a <a class="reference internal" href="./placeholders.html#placeholder">placeholder</a>, and</p>
  147. <pre class="literal-block">
  148. template&lt; typename X, typename U1,<em>...</em> typename U<em>n</em> &gt; struct h<em>k</em>
  149. {
  150. typedef X type;
  151. };
  152. </pre>
  153. <p class="last">otherwise. [<em>Note:</em> Every <tt class="literal"><span class="pre">n</span></tt>th appearance of the <a class="reference internal" href="./placeholders.html">unnamed placeholder</a>
  154. in the <tt class="literal"><span class="pre"><a href="./bind.html" class="identifier">bind</a>&lt;f,a1,...an&gt;</span></tt> specialization is replaced with the corresponding
  155. numbered placeholder <tt class="literal"><span class="pre">_</span></tt><em>n</em> — <em>end note</em>]</p>
  156. </td>
  157. </tr>
  158. </tbody>
  159. </table>
  160. </div>
  161. <div class="section" id="id936">
  162. <h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
  163. <pre class="literal-block">
  164. struct f1
  165. {
  166. template&lt; typename T1 &gt; struct <a href="./apply.html" class="identifier">apply</a>
  167. {
  168. typedef T1 type;
  169. };
  170. };
  171. struct f5
  172. {
  173. template&lt; typename T1, typename T2, typename T3, typename T4, typename T5 &gt;
  174. struct <a href="./apply.html" class="identifier">apply</a>
  175. {
  176. typedef T5 type;
  177. };
  178. };
  179. typedef <a href="./apply-wrap.html" class="identifier">apply_wrap</a><tt class="literal"><span class="pre">1</span></tt>&lt;
  180. <a href="./bind.html" class="identifier">bind</a><tt class="literal"><span class="pre">1</span></tt>&lt;f1,<a href="./placeholders.html" class="identifier">_1</a>&gt;
  181. , int
  182. &gt;::type r11;
  183. typedef <a href="./apply-wrap.html" class="identifier">apply_wrap</a><tt class="literal"><span class="pre">5</span></tt>&lt;
  184. <a href="./bind.html" class="identifier">bind</a><tt class="literal"><span class="pre">1</span></tt>&lt;f1,<a href="./placeholders.html" class="identifier">_5</a>&gt;
  185. , void,void,void,void,int
  186. &gt;::type r12;
  187. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt;r11,int&gt; ));
  188. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt;r12,int&gt; ));
  189. typedef <a href="./apply-wrap.html" class="identifier">apply_wrap</a><tt class="literal"><span class="pre">5</span></tt>&lt;
  190. <a href="./bind.html" class="identifier">bind</a><tt class="literal"><span class="pre">5</span></tt>&lt;f5,<a href="./placeholders.html" class="identifier">_1</a>,<a href="./placeholders.html" class="identifier">_2</a>,<a href="./placeholders.html" class="identifier">_3</a>,<a href="./placeholders.html" class="identifier">_4</a>,<a href="./placeholders.html" class="identifier">_5</a>&gt;
  191. , void,void,void,void,int
  192. &gt;::type r51;
  193. typedef <a href="./apply-wrap.html" class="identifier">apply_wrap</a><tt class="literal"><span class="pre">5</span></tt>&lt;
  194. <a href="./bind.html" class="identifier">bind</a><tt class="literal"><span class="pre">5</span></tt>&lt;f5,<a href="./placeholders.html" class="identifier">_5</a>,<a href="./placeholders.html" class="identifier">_4</a>,<a href="./placeholders.html" class="identifier">_3</a>,<a href="./placeholders.html" class="identifier">_2</a>,<a href="./placeholders.html" class="identifier">_1</a>&gt;
  195. , int,void,void,void,void
  196. &gt;::type r52;
  197. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt;r51,int&gt; ));
  198. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt;r52,int&gt; ));
  199. </pre>
  200. </div>
  201. <div class="section" id="id937">
  202. <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
  203. <p><a class="reference internal" href="./composition-and-argument-binding.html">Composition and Argument Binding</a>, <a class="reference internal" href="./invocation.html">invocation</a>, <a class="reference internal" href="./placeholders.html">Placeholders</a>, <a class="reference internal" href="./lambda.html">lambda</a>, <a class="reference internal" href="./quote.html">quote</a>,
  204. <a class="reference internal" href="./protect.html">protect</a>, <a class="reference internal" href="./apply.html">apply</a>, <a class="reference internal" href="./apply-wrap.html">apply_wrap</a></p>
  205. <!-- Metafunctions/Composition and Argument Binding//quote |40 -->
  206. </div>
  207. </div>
  208. <div class="footer-separator"></div>
  209. <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./lambda.html" class="navigation-link">Prev</a>&nbsp;<a href="./quote.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./lambda.html" class="navigation-link">Back</a>&nbsp;<a href="./quote.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./composition-and-argument-binding.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>
  210. <td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div>
  211. Distributed under the Boost Software License, Version 1.0. (See accompanying
  212. 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>
  213. </html>