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