Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/libs/mpl/doc/refmanual/bind.html @ 12

Last change on this file since 12 was 12, checked in by landauf, 17 years ago

added boost
File size: 11.8 KB
Line 
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.3.6: 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.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.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.html#id457" name="bind">bind</a></h1>
16<div class="section" id="bind-synopsis">
17<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
18<pre class="literal-block">
19template&lt; 
20      typename F
21    &gt;
22struct bind0
23{
24    // <em>unspecified</em>
25    // <em>...</em>
26};
27
28template&lt; 
29      typename F, typename A1
30    &gt;
31struct bind1
32{
33    // <em>unspecified</em>
34    // <em>...</em>
35};
36
37<em>...</em>
38
39template&lt; 
40      typename F, typename A1,<em>...</em> typename An
41    &gt;
42struct <a href="./bind.html" class="identifier">bind</a><em>n</em>
43{
44    // <em>unspecified</em>
45    // <em>...</em>
46};
47
48template&lt; 
49      typename F
50    , typename A1 = <em>unspecified</em>
51    <em>...</em>
52    , typename An = <em>unspecified</em>
53    &gt;
54struct <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="bind-description">
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" href="./metafunction-class.html">Metafunction Class</a> composition
64and argument binding. In essence, it's a compile-time counterpart of
65the similar run-time functionality provided by <a class="reference" href="http://www.boost.org/libs/bind/bind.html" target="_top">Boost.Bind</a> and <a class="reference" href="http://www.boost.org/libs/lambda/doc/index.html" target="_top">Boost.Lambda</a>
66libraries.</p>
67</div>
68<div class="section" id="bind-header">
69<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
70<pre class="literal-block">
71#include &lt;<a href="../../../../boost/mpl/bind.hpp" class="header">boost/mpl/bind.hpp</a>&gt;
72</pre>
73</div>
74<div class="section" id="bind-model-of">
75<h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
76<p><a class="reference" href="./metafunction-class.html">Metafunction Class</a></p>
77</div>
78<div class="section" id="bind-parameters">
79<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
80<table border="1" class="table">
81<colgroup>
82<col width="15%" />
83<col width="36%" />
84<col width="48%" />
85</colgroup>
86<thead valign="bottom">
87<tr><th>Parameter</th>
88<th>Requirement</th>
89<th>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" 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="bind-expression-semantics">
105<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
106<p>For any <a class="reference" 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">
108typedef <a href="./bind.html" class="identifier">bind</a>&lt;f,a1,...a<em>n</em>&gt; g;
109typedef <a href="./bind.html" class="identifier">bind</a><em>n</em>&lt;f,a1,...a<em>n</em>&gt; g;
110</pre>
111<table class="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" href="./metafunction-class.html">Metafunction Class</a></td>
116</tr>
117</tbody>
118</table>
119<a class="target" id="bind-semantics" name="bind-semantics"></a><table class="field-list" frame="void" 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">
125struct g
126{
127    template&lt; 
128          typename U1 = <em>unspecified</em>
129        <em>...</em>
130        , typename U<em>n</em> = <em>unspecified</em>
131        &gt;
132    struct <a href="./apply.html" class="identifier">apply</a>
133        : <a href="./apply-wrap.html" class="identifier">apply_wrap</a><em>n</em>&lt;
134              typename h0&lt;f,U1,<em>...</em>U<em>n</em>&gt;::type
135            , typename h1&lt;a1,U1,<em>...</em>U<em>n</em>&gt;::type
136            <em>...</em>
137            , typename h<em>n</em>&lt;a<em>n</em>,U1,<em>...</em>U<em>n</em>&gt;::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">
145template&lt; typename X, typename U1,<em>...</em> typename U<em>n</em> &gt; struct h<em>k</em>
146    : <a href="./apply-wrap.html" class="identifier">apply_wrap</a><em>n</em>&lt;X,U1,<em>...</em>U<em>n</em>&gt;
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" href="./terminology.html#bind-expression">bind expression</a> or a <a class="reference" href="./placeholders.html">placeholder</a>, and</p>
151<pre class="literal-block">
152template&lt; typename X, typename U1,<em>...</em> typename U<em>n</em> &gt; 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" href="./placeholders.html">unnamed placeholder</a> 
158in 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
159numbered 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="bind-example">
166<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
167<pre class="literal-block">
168struct f1
169{
170    template&lt; typename T1 &gt; struct <a href="./apply.html" class="identifier">apply</a>
171    {
172        typedef T1 type;
173    };
174};
175
176struct f5
177{
178    template&lt; typename T1, typename T2, typename T3, typename T4, typename T5 &gt;
179    struct <a href="./apply.html" class="identifier">apply</a>
180    {
181        typedef T5 type;
182    };
183};
184
185typedef <a href="./apply-wrap.html" class="identifier">apply_wrap</a><tt class="literal"><span class="pre">1</span></tt>&lt; 
186      <a href="./bind.html" class="identifier">bind</a><tt class="literal"><span class="pre">1</span></tt>&lt;f1,_1&gt;
187    , int
188    &gt;::type r11;
189
190typedef <a href="./apply-wrap.html" class="identifier">apply_wrap</a><tt class="literal"><span class="pre">5</span></tt>&lt; 
191      <a href="./bind.html" class="identifier">bind</a><tt class="literal"><span class="pre">1</span></tt>&lt;f1,_5&gt;
192    , void,void,void,void,int
193    &gt;::type r12;
194
195<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt;r11,int&gt; ));
196<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt;r12,int&gt; ));
197
198typedef <a href="./apply-wrap.html" class="identifier">apply_wrap</a><tt class="literal"><span class="pre">5</span></tt>&lt; 
199      <a href="./bind.html" class="identifier">bind</a><tt class="literal"><span class="pre">5</span></tt>&lt;f5,_1,_2,_3,_4,_5&gt;
200    , void,void,void,void,int
201    &gt;::type r51;
202
203typedef <a href="./apply-wrap.html" class="identifier">apply_wrap</a><tt class="literal"><span class="pre">5</span></tt>&lt;
204      <a href="./bind.html" class="identifier">bind</a><tt class="literal"><span class="pre">5</span></tt>&lt;f5,_5,_4,_3,_2,_1&gt;
205    , int,void,void,void,void
206    &gt;::type r52;
207
208<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt;r51,int&gt; ));
209<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt;r52,int&gt; ));
210</pre>
211</div>
212<div class="section" id="bind-see-also">
213<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
214<p><a class="reference" href="./composition-and-argument.html">Composition and Argument Binding</a>, <a class="reference" href="./invocation.html">invocation</a>, <a class="reference" href="./placeholders.html">Placeholders</a>, <a class="refentry reference" href="./lambda.html"><tt class="refentry literal"><span class="pre">lambda</span></tt></a>, <a class="refentry reference" href="./quote.html"><tt class="refentry literal"><span class="pre">quote</span></tt></a>,
215<a class="refentry reference" href="./protect.html"><tt class="refentry literal"><span class="pre">protect</span></tt></a>, <a class="refentry reference" href="./apply.html"><tt class="refentry literal"><span class="pre">apply</span></tt></a>, <a class="refentry reference" href="./apply-wrap.html"><tt class="refentry literal"><span class="pre">apply_wrap</span></tt></a></p>
216<!-- modtime: November 13, 2004 01:59:44 +0000 -->
217<!-- Metafunctions/Composition and Argument Binding//quote |40 -->
218</div>
219</div>
220
221<div class="footer-separator"></div>
222<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.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>
223</tr></table></body>
224</html>
Note: See TracBrowser for help on using the repository browser.