libs/fusion/doc/html/fusion/algorithm/transformation/functions/join.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>join</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="insert_range.html" title="insert_range">
  10 <link rel="next" href="zip.html" title="zip">
  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="insert_range.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="zip.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.algorithm.transformation.functions.join"></a><a class="link" href="join.html" title="join">join</a>
  28 </h5></div></div></div>
  29 <h6>
  30 <a name="fusion.algorithm.transformation.functions.join.h0"></a>
  31             <span class="phrase"><a name="fusion.algorithm.transformation.functions.join.description"></a></span><a class="link" href="join.html#fusion.algorithm.transformation.functions.join.description">Description</a>
  32           </h6>
  33 <p>
  34             Takes 2 sequences and returns a sequence containing the elements of the
  35             first followed by the elements of the second.
  36           </p>
  37 <h6>
  38 <a name="fusion.algorithm.transformation.functions.join.h1"></a>
  39             <span class="phrase"><a name="fusion.algorithm.transformation.functions.join.synopsis"></a></span><a class="link" href="join.html#fusion.algorithm.transformation.functions.join.synopsis">Synopsis</a>
  40           </h6>
  41 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  42     <span class="keyword">typename</span> <span class="identifier">LhSequence</span><span class="special">,</span>
  43     <span class="keyword">typename</span> <span class="identifier">RhSequence</span><span class="special">&gt;</span>
  44 <span class="keyword">typename</span> <a class="link" href="../metafunctions/join.html" title="join"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">join</span></code></a><span class="special">&lt;</span><span class="identifier">LhSequence</span><span class="special">,</span> <span class="identifier">RhSequence</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">join</span><span class="special">(</span><span class="identifier">LhSequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">lhs</span><span class="special">,</span> <span class="identifier">RhSequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
  45 </pre>
  46 <div class="table">
  47 <a name="fusion.algorithm.transformation.functions.join.t0"></a><p class="title"><b>Table&#160;1.78.&#160;Parameters</b></p>
  48 <div class="table-contents"><table class="table" summary="Parameters">
  49 <colgroup>
  50 <col>
  51 <col>
  52 <col>
  53 </colgroup>
  54 <thead><tr>
  55 <th>
  56                     <p>
  57                       Parameter
  58                     </p>
  59                   </th>
  60 <th>
  61                     <p>
  62                       Requirement
  63                     </p>
  64                   </th>
  65 <th>
  66                     <p>
  67                       Description
  68                     </p>
  69                   </th>
  70 </tr></thead>
  71 <tbody>
  72 <tr>
  73 <td>
  74                     <p>
  75                       <code class="computeroutput"><span class="identifier">lhs</span></code>
  76                     </p>
  77                   </td>
  78 <td>
  79                     <p>
  80                       A model of <a class="link" href="../../../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward
  81                       Sequence</a>
  82                     </p>
  83                   </td>
  84 <td>
  85                     <p>
  86                       Operation's argument
  87                     </p>
  88                   </td>
  89 </tr>
  90 <tr>
  91 <td>
  92                     <p>
  93                       <code class="computeroutput"><span class="identifier">rhs</span></code>
  94                     </p>
  95                   </td>
  96 <td>
  97                     <p>
  98                       A model of <a class="link" href="../../../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward
  99                       Sequence</a>
 100                     </p>
 101                   </td>
 102 <td>
 103                     <p>
 104                       Operation's argument
 105                     </p>
 106                   </td>
 107 </tr>
 108 </tbody>
 109 </table></div>
 110 </div>
 111 <br class="table-break"><h6>
 112 <a name="fusion.algorithm.transformation.functions.join.h2"></a>
 113             <span class="phrase"><a name="fusion.algorithm.transformation.functions.join.expression_semantics"></a></span><a class="link" href="join.html#fusion.algorithm.transformation.functions.join.expression_semantics">Expression
 114             Semantics</a>
 115           </h6>
 116 <pre class="programlisting"><a class="link" href="join.html" title="join"><code class="computeroutput"><span class="identifier">join</span></code></a><span class="special">(</span><span class="identifier">lhs</span><span class="special">,</span> <span class="identifier">rhs</span><span class="special">);</span>
 117 </pre>
 118 <p>
 119             <span class="bold"><strong>Return type</strong></span>:
 120           </p>
 121 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 122 <li class="listitem">
 123                 A model of <a class="link" href="../../../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward
 124                 Sequence</a>.
 125               </li>
 126 <li class="listitem">
 127                 A model of <a class="link" href="../../../sequence/concepts/associative_sequence.html" title="Associative Sequence">Associative
 128                 Sequence</a> if <code class="computeroutput"><span class="identifier">lhs</span></code>
 129                 and <code class="computeroutput"><span class="identifier">rhs</span></code> implement
 130                 the <a class="link" href="../../../sequence/concepts/associative_sequence.html" title="Associative Sequence">Associative
 131                 Sequence</a> model.
 132               </li>
 133 </ul></div>
 134 <p>
 135             <span class="bold"><strong>Semantics</strong></span>: Returns a sequence containing
 136             all the elements of <code class="computeroutput"><span class="identifier">lhs</span></code>
 137             followed by all the elements of <code class="computeroutput"><span class="identifier">rhs</span></code>.
 138             The order of the elements is preserved.
 139           </p>
 140 <h6>
 141 <a name="fusion.algorithm.transformation.functions.join.h3"></a>
 142             <span class="phrase"><a name="fusion.algorithm.transformation.functions.join.complexity"></a></span><a class="link" href="join.html#fusion.algorithm.transformation.functions.join.complexity">Complexity</a>
 143           </h6>
 144 <p>
 145             Constant. Returns a view which is lazily evaluated.
 146           </p>
 147 <h6>
 148 <a name="fusion.algorithm.transformation.functions.join.h4"></a>
 149             <span class="phrase"><a name="fusion.algorithm.transformation.functions.join.header"></a></span><a class="link" href="join.html#fusion.algorithm.transformation.functions.join.header">Header</a>
 150           </h6>
 151 <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">algorithm</span><span class="special">/</span><span class="identifier">transformation</span><span class="special">/</span><span class="identifier">join</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 152 <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">join</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 153 </pre>
 154 <h6>
 155 <a name="fusion.algorithm.transformation.functions.join.h5"></a>
 156             <span class="phrase"><a name="fusion.algorithm.transformation.functions.join.example"></a></span><a class="link" href="join.html#fusion.algorithm.transformation.functions.join.example">Example</a>
 157           </h6>
 158 <pre class="programlisting"><a class="link" href="../../../container/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span><span class="keyword">char</span><span class="special">&gt;</span> <span class="identifier">v1</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="char">'a'</span><span class="special">);</span>
 159 <a class="link" href="../../../container/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span><span class="keyword">char</span><span class="special">&gt;</span> <span class="identifier">v2</span><span class="special">(</span><span class="number">2</span><span class="special">,</span> <span class="char">'b'</span><span class="special">);</span>
 160 <span class="identifier">assert</span><span class="special">(</span><a class="link" href="join.html" title="join"><code class="computeroutput"><span class="identifier">join</span></code></a><span class="special">(</span><span class="identifier">v1</span><span class="special">,</span> <span class="identifier">v2</span><span class="special">)</span> <span class="special">==</span> <a class="link" href="../../../container/generation/functions/make_vector.html" title="make_vector"><code class="computeroutput"><span class="identifier">make_vector</span></code></a><span class="special">(</span><span class="number">1</span><span class="special">,</span><span class="char">'a'</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="char">'b'</span><span class="special">));</span>
 161 </pre>
 162 </div>
 163 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 164 <td align="left"></td>
 165 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2006, 2011, 2012 Joel de Guzman,
 166       Dan Marsden, Tobias Schwinger<p>
 167         Distributed under the Boost Software License, Version 1.0. (See accompanying
 168         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>)
 169       </p>
 170 </div></td>
 171 </tr></table>
 172 <hr>
 173 <div class="spirit-nav">
 174 <a accesskey="p" href="insert_range.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="zip.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 175 </div>
 176 </body>
 177 </html>