Release 1.39.0
[boost.git] / Boost_1_39_0 / libs / fusion / doc / html / fusion / container / generation / functions / list_tie.html
blobcb73d6cef0a3fbfb9f9c0ed2f8c1a2ab2ed11925
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4 <title>list_tie</title>
5 <link rel="stylesheet" href="../../../../../../../../doc/html/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
7 <link rel="start" href="../../../../index.html" title="Chapter 1. Fusion 2.0">
8 <link rel="up" href="../functions.html" title="Functions">
9 <link rel="prev" href="tiers.html" title="Tiers">
10 <link rel="next" href="vector_tie.html" title="vector_tie">
11 </head>
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr>
14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
15 <td align="center"><a href="../../../../../../../../index.html">Home</a></td>
16 <td align="center"><a href="../../../../../../../libraries.htm">Libraries</a></td>
17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19 <td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
20 </tr></table>
21 <hr>
22 <div class="spirit-nav">
23 <a accesskey="p" href="tiers.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="vector_tie.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
24 </div>
25 <div class="section" lang="en">
26 <div class="titlepage"><div><div><h5 class="title">
27 <a name="fusion.container.generation.functions.list_tie"></a><a href="list_tie.html" title="list_tie">list_tie</a></h5></div></div></div>
28 <a name="fusion.container.generation.functions.list_tie.description"></a><h6>
29 <a name="id545095"></a>
30 <a href="list_tie.html#fusion.container.generation.functions.list_tie.description">Description</a>
31 </h6>
32 <p>
33 Constructs a tie using a <a href="../../list.html" title="list"><tt class="computeroutput"><span class="identifier">list</span></tt></a> sequence.
34 </p>
35 <a name="fusion.container.generation.functions.list_tie.synopsis"></a><h6>
36 <a name="id545144"></a>
37 <a href="list_tie.html#fusion.container.generation.functions.list_tie.synopsis">Synopsis</a>
38 </h6>
39 <pre class="programlisting">
40 <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T0</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T1</span><span class="special">,...</span> <span class="keyword">typename</span> <span class="identifier">TN</span><span class="special">&gt;</span>
41 <a href="../../list.html" title="list"><tt class="computeroutput"><span class="identifier">list</span></tt></a><span class="special">&lt;</span><span class="identifier">T0</span><span class="special">&amp;,</span> <span class="identifier">T1</span><span class="special">&amp;,...</span> <span class="identifier">TN</span><span class="special">&amp;&gt;</span>
42 <span class="identifier">list_tie</span><span class="special">(</span><span class="identifier">T0</span><span class="special">&amp;</span> <span class="identifier">x0</span><span class="special">,</span> <span class="identifier">T1</span><span class="special">&amp;</span> <span class="identifier">x1</span><span class="special">...</span> <span class="identifier">TN</span><span class="special">&amp;</span> <span class="identifier">xN</span><span class="special">);</span>
43 </pre>
44 <p>
45 The variadic function accepts <tt class="computeroutput"><span class="number">0</span></tt>
46 to <tt class="computeroutput"><span class="identifier">FUSION_MAX_LIST_SIZE</span></tt>
47 elements, where <tt class="computeroutput"><span class="identifier">FUSION_MAX_LIST_SIZE</span></tt>
48 is a user definable predefined maximum that defaults to <tt class="computeroutput"><span class="number">10</span></tt>. You may define the preprocessor constant
49 <tt class="computeroutput"><span class="identifier">FUSION_MAX_LIST_SIZE</span></tt>
50 before including any Fusion header to change the default. Example:
51 </p>
52 <pre class="programlisting">
53 <span class="preprocessor">#define</span> <span class="identifier">FUSION_MAX_LIST_SIZE</span> <span class="number">20</span>
54 </pre>
55 <a name="fusion.container.generation.functions.list_tie.parameters"></a><h6>
56 <a name="id545462"></a>
57 <a href="list_tie.html#fusion.container.generation.functions.list_tie.parameters">Parameters</a>
58 </h6>
59 <div class="informaltable"><table class="table">
60 <colgroup>
61 <col>
62 <col>
63 <col>
64 </colgroup>
65 <thead><tr>
66 <th>
67 <p>
68 Parameter
69 </p>
70 </th>
71 <th>
72 <p>
73 Requirement
74 </p>
75 </th>
76 <th>
77 <p>
78 Description
79 </p>
80 </th>
81 </tr></thead>
82 <tbody><tr>
83 <td>
84 <p>
85 <tt class="computeroutput"><span class="identifier">x0</span><span class="special">,</span>
86 <span class="identifier">x1</span><span class="special">,...</span>
87 <span class="identifier">xN</span></tt>
88 </p>
89 </td>
90 <td>
91 <p>
92 Instances of <tt class="computeroutput"><span class="identifier">T0</span><span class="special">,</span> <span class="identifier">T1</span><span class="special">,...</span> <span class="identifier">TN</span></tt>
93 </p>
94 </td>
95 <td>
96 <p>
97 The arguments to <tt class="computeroutput"><span class="identifier">list_tie</span></tt>
98 </p>
99 </td>
100 </tr></tbody>
101 </table></div>
102 <a name="fusion.container.generation.functions.list_tie.expression_semantics"></a><h6>
103 <a name="id545638"></a>
104 <a href="list_tie.html#fusion.container.generation.functions.list_tie.expression_semantics">Expression
105 Semantics</a>
106 </h6>
107 <pre class="programlisting">
108 <span class="identifier">list_tie</span><span class="special">(</span><span class="identifier">x0</span><span class="special">,</span> <span class="identifier">x1</span><span class="special">,...</span> <span class="identifier">xN</span><span class="special">);</span>
109 </pre>
111 <span class="bold"><b>Return type</b></span>: <a href="../../list.html" title="list"><tt class="computeroutput"><span class="identifier">list</span></tt></a>&lt;T0&amp;, T1&amp;,...
112 TN&amp;&gt;
113 </p>
115 <span class="bold"><b>Semantics</b></span>: Create a <a href="../../list.html" title="list"><tt class="computeroutput"><span class="identifier">list</span></tt></a> of references from <tt class="computeroutput"><span class="identifier">x0</span><span class="special">,</span> <span class="identifier">x1</span><span class="special">,...</span> <span class="identifier">xN</span></tt>.
116 </p>
117 <a name="fusion.container.generation.functions.list_tie.header"></a><h6>
118 <a name="id545808"></a>
119 <a href="list_tie.html#fusion.container.generation.functions.list_tie.header">Header</a>
120 </h6>
121 <pre class="programlisting">
122 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">container</span><span class="special">/</span><span class="identifier">generation</span><span class="special">/</span><span class="identifier">list_tie</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
123 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">include</span><span class="special">/</span><span class="identifier">list_tie</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
124 </pre>
125 <a name="fusion.container.generation.functions.list_tie.example"></a><h6>
126 <a name="id545978"></a>
127 <a href="list_tie.html#fusion.container.generation.functions.list_tie.example">Example</a>
128 </h6>
129 <pre class="programlisting">
130 <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">=</span> <span class="number">123</span><span class="special">;</span>
131 <span class="keyword">double</span> <span class="identifier">d</span> <span class="special">=</span> <span class="number">123.456</span><span class="special">;</span>
132 <span class="identifier">list_tie</span><span class="special">(</span><span class="identifier">i</span><span class="special">,</span> <span class="identifier">d</span><span class="special">)</span>
133 </pre>
134 </div>
135 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
136 <td align="left"></td>
137 <td align="right"><div class="copyright-footer">Copyright © 2001-2007 Joel de Guzman, Dan Marsden, Tobias
138 Schwinger<p>
139 Distributed under the Boost Software License, Version 1.0. (See accompanying
140 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
141 </p>
142 </div></td>
143 </tr></table>
144 <hr>
145 <div class="spirit-nav">
146 <a accesskey="p" href="tiers.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="vector_tie.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
147 </div>
148 </body>
149 </html>