libs/fusion/doc/html/fusion/container/generation/functions/list_tie.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>list_tie</title>
   5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Fusion 2.2">
   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="../../../../../../../../libs/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/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="vector_tie.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="fusion.container.generation.functions.list_tie"></a><a class="link" href="list_tie.html" title="list_tie">list_tie</a>
  28 </h5></div></div></div>
  29 <h6>
  30 <a name="fusion.container.generation.functions.list_tie.h0"></a>
  31             <span class="phrase"><a name="fusion.container.generation.functions.list_tie.description"></a></span><a class="link" href="list_tie.html#fusion.container.generation.functions.list_tie.description">Description</a>
  32           </h6>
  33 <p>
  34             Constructs a tie using a <a class="link" href="../../list.html" title="list"><code class="computeroutput"><span class="identifier">list</span></code></a> sequence.
  35           </p>
  36 <h6>
  37 <a name="fusion.container.generation.functions.list_tie.h1"></a>
  38             <span class="phrase"><a name="fusion.container.generation.functions.list_tie.synopsis"></a></span><a class="link" href="list_tie.html#fusion.container.generation.functions.list_tie.synopsis">Synopsis</a>
  39           </h6>
  40 <pre class="programlisting"><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 class="link" href="../../list.html" title="list"><code class="computeroutput"><span class="identifier">list</span></code></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 <code class="computeroutput"><span class="number">0</span></code>
  46             to <code class="computeroutput"><span class="identifier">FUSION_MAX_LIST_SIZE</span></code>
  47             elements, where <code class="computeroutput"><span class="identifier">FUSION_MAX_LIST_SIZE</span></code>
  48             is a user definable predefined maximum that defaults to <code class="computeroutput"><span class="number">10</span></code>. You may define the preprocessor constant
  49             <code class="computeroutput"><span class="identifier">FUSION_MAX_LIST_SIZE</span></code>
  50             before including any Fusion header to change the default. Example:
  51           </p>
  52 <pre class="programlisting"><span class="preprocessor">#define</span> <span class="identifier">FUSION_MAX_LIST_SIZE</span> <span class="number">20</span>
  53 </pre>
  54 <h6>
  55 <a name="fusion.container.generation.functions.list_tie.h2"></a>
  56             <span class="phrase"><a name="fusion.container.generation.functions.list_tie.parameters"></a></span><a class="link" href="list_tie.html#fusion.container.generation.functions.list_tie.parameters">Parameters</a>
  57           </h6>
  58 <div class="informaltable"><table class="table">
  59 <colgroup>
  60 <col>
  61 <col>
  62 <col>
  63 </colgroup>
  64 <thead><tr>
  65 <th>
  66                     <p>
  67                       Parameter
  68                     </p>
  69                   </th>
  70 <th>
  71                     <p>
  72                       Requirement
  73                     </p>
  74                   </th>
  75 <th>
  76                     <p>
  77                       Description
  78                     </p>
  79                   </th>
  80 </tr></thead>
  81 <tbody><tr>
  82 <td>
  83                     <p>
  84                       <code class="computeroutput"><span class="identifier">x0</span><span class="special">,</span>
  85                       <span class="identifier">x1</span><span class="special">,...</span>
  86                       <span class="identifier">xN</span></code>
  87                     </p>
  88                   </td>
  89 <td>
  90                     <p>
  91                       Instances of <code 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></code>
  92                     </p>
  93                   </td>
  94 <td>
  95                     <p>
  96                       The arguments to <code class="computeroutput"><span class="identifier">list_tie</span></code>
  97                     </p>
  98                   </td>
  99 </tr></tbody>
 100 </table></div>
 101 <h6>
 102 <a name="fusion.container.generation.functions.list_tie.h3"></a>
 103             <span class="phrase"><a name="fusion.container.generation.functions.list_tie.expression_semantics"></a></span><a class="link" href="list_tie.html#fusion.container.generation.functions.list_tie.expression_semantics">Expression
 104             Semantics</a>
 105           </h6>
 106 <pre class="programlisting"><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>
 107 </pre>
 108 <p>
 109             <span class="bold"><strong>Return type</strong></span>: <a class="link" href="../../list.html" title="list"><code class="computeroutput"><span class="identifier">list</span></code></a>&lt;T0&amp;, T1&amp;,...
 110             TN&amp;&gt;
 111           </p>
 112 <p>
 113             <span class="bold"><strong>Semantics</strong></span>: Create a <a class="link" href="../../list.html" title="list"><code class="computeroutput"><span class="identifier">list</span></code></a> of references from <code 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></code>.
 114           </p>
 115 <h6>
 116 <a name="fusion.container.generation.functions.list_tie.h4"></a>
 117             <span class="phrase"><a name="fusion.container.generation.functions.list_tie.header"></a></span><a class="link" href="list_tie.html#fusion.container.generation.functions.list_tie.header">Header</a>
 118           </h6>
 119 <pre class="programlisting"><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>
 120 <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>
 121 </pre>
 122 <h6>
 123 <a name="fusion.container.generation.functions.list_tie.h5"></a>
 124             <span class="phrase"><a name="fusion.container.generation.functions.list_tie.example"></a></span><a class="link" href="list_tie.html#fusion.container.generation.functions.list_tie.example">Example</a>
 125           </h6>
 126 <pre class="programlisting"><span class="keyword">int</span> <span class="identifier">i</span> <span class="special">=</span> <span class="number">123</span><span class="special">;</span>
 127 <span class="keyword">double</span> <span class="identifier">d</span> <span class="special">=</span> <span class="number">123.456</span><span class="special">;</span>
 128 <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>
 129 </pre>
 130 </div>
 131 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 132 <td align="left"></td>
 133 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2006, 2011, 2012 Joel de Guzman,
 134       Dan Marsden, Tobias Schwinger<p>
 135         Distributed under the Boost Software License, Version 1.0. (See accompanying
 136         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>)
 137       </p>
 138 </div></td>
 139 </tr></table>
 140 <hr>
 141 <div class="spirit-nav">
 142 <a accesskey="p" href="tiers.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="vector_tie.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 143 </div>
 144 </body>
 145 </html>