• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>zip</title>
5<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="../../../../index.html" title="Chapter 1. Fusion 2.2">
8<link rel="up" href="../functions.html" title="Functions">
9<link rel="prev" href="join.html" title="join">
10<link rel="next" href="pop_back.html" title="pop_back">
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="join.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="pop_back.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.zip"></a><a class="link" href="zip.html" title="zip">zip</a>
28</h5></div></div></div>
29<h6>
30<a name="fusion.algorithm.transformation.functions.zip.h0"></a>
31            <span class="phrase"><a name="fusion.algorithm.transformation.functions.zip.description"></a></span><a class="link" href="zip.html#fusion.algorithm.transformation.functions.zip.description">Description</a>
32          </h6>
33<p>
34            Zips sequences together to form a single sequence, whose members are
35            tuples of the members of the component sequences.
36          </p>
37<h6>
38<a name="fusion.algorithm.transformation.functions.zip.h1"></a>
39            <span class="phrase"><a name="fusion.algorithm.transformation.functions.zip.synopsis"></a></span><a class="link" href="zip.html#fusion.algorithm.transformation.functions.zip.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">Sequence1</span><span class="special">,</span>
43    <span class="keyword">typename</span> <span class="identifier">Sequence2</span><span class="special">,</span>
44    <span class="special">...</span>
45    <span class="keyword">typename</span> <span class="identifier">SequenceN</span>
46    <span class="special">&gt;</span>
47<span class="keyword">typename</span> <a class="link" href="../metafunctions/zip.html" title="zip"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">zip</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence1</span> <span class="keyword">const</span><span class="special">,</span> <span class="identifier">Sequence2</span> <span class="keyword">const</span><span class="special">,</span> <span class="special">...</span> <span class="identifier">SequenceN</span> <span class="keyword">const</span><span class="special">&gt;::</span><span class="identifier">type</span>
48<span class="identifier">zip</span><span class="special">(</span><span class="identifier">Sequence1</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seq1</span><span class="special">,</span> <span class="identifier">Sequence2</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seq2</span><span class="special">,</span> <span class="special">...</span> <span class="identifier">SequenceN</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seqN</span><span class="special">);</span>
49</pre>
50<div class="table">
51<a name="fusion.algorithm.transformation.functions.zip.t0"></a><p class="title"><b>Table 1.81. Parameters</b></p>
52<div class="table-contents"><table class="table" summary="Parameters">
53<colgroup>
54<col>
55<col>
56<col>
57</colgroup>
58<thead><tr>
59<th>
60                    <p>
61                      Parameter
62                    </p>
63                  </th>
64<th>
65                    <p>
66                      Requirement
67                    </p>
68                  </th>
69<th>
70                    <p>
71                      Description
72                    </p>
73                  </th>
74</tr></thead>
75<tbody><tr>
76<td>
77                    <p>
78                      <code class="computeroutput"><span class="identifier">seq1</span></code> to <code class="computeroutput"><span class="identifier">seqN</span></code>
79                    </p>
80                  </td>
81<td>
82                    <p>
83                      Each sequence is a model of <a class="link" href="../../../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward
84                      Sequence</a>.
85                    </p>
86                  </td>
87<td>
88                    <p>
89                      Operation's argument
90                    </p>
91                  </td>
92</tr></tbody>
93</table></div>
94</div>
95<br class="table-break"><h6>
96<a name="fusion.algorithm.transformation.functions.zip.h2"></a>
97            <span class="phrase"><a name="fusion.algorithm.transformation.functions.zip.expression_semantics"></a></span><a class="link" href="zip.html#fusion.algorithm.transformation.functions.zip.expression_semantics">Expression
98            Semantics</a>
99          </h6>
100<pre class="programlisting"><a class="link" href="zip.html" title="zip"><code class="computeroutput"><span class="identifier">zip</span></code></a><span class="special">(</span><span class="identifier">seq1</span><span class="special">,</span> <span class="identifier">seq2</span><span class="special">,</span> <span class="special">...</span> <span class="identifier">seqN</span><span class="special">);</span>
101</pre>
102<p>
103            <span class="bold"><strong>Return type</strong></span>: A model of <a class="link" href="../../../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward
104            Sequence</a>.
105          </p>
106<p>
107            <span class="bold"><strong>Semantics</strong></span>: Returns a sequence containing
108            tuples of elements from sequences <code class="computeroutput"><span class="identifier">seq1</span></code>
109            to <code class="computeroutput"><span class="identifier">seqN</span></code>. For example,
110            applying zip to tuples <code class="computeroutput"><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">)</span></code>
111            and <code class="computeroutput"><span class="special">(</span><span class="char">'a'</span><span class="special">,</span> <span class="char">'b'</span><span class="special">,</span>
112            <span class="char">'c'</span><span class="special">)</span></code>
113            would return <code class="computeroutput"><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><span class="number">3</span><span class="special">,</span>
114            <span class="char">'c'</span><span class="special">))</span></code>
115          </p>
116<h6>
117<a name="fusion.algorithm.transformation.functions.zip.h3"></a>
118            <span class="phrase"><a name="fusion.algorithm.transformation.functions.zip.complexity"></a></span><a class="link" href="zip.html#fusion.algorithm.transformation.functions.zip.complexity">Complexity</a>
119          </h6>
120<p>
121            Constant. Returns a view which is lazily evaluated.
122          </p>
123<h6>
124<a name="fusion.algorithm.transformation.functions.zip.h4"></a>
125            <span class="phrase"><a name="fusion.algorithm.transformation.functions.zip.header"></a></span><a class="link" href="zip.html#fusion.algorithm.transformation.functions.zip.header">Header</a>
126          </h6>
127<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">zip</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
128<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">zip</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
129</pre>
130<h6>
131<a name="fusion.algorithm.transformation.functions.zip.h5"></a>
132            <span class="phrase"><a name="fusion.algorithm.transformation.functions.zip.example"></a></span><a class="link" href="zip.html#fusion.algorithm.transformation.functions.zip.example">Example</a>
133          </h6>
134<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>
135<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>
136<span class="identifier">assert</span><span class="special">(</span><a class="link" href="zip.html" title="zip"><code class="computeroutput"><span class="identifier">zip</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><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="number">2</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="char">'a'</span><span class="special">,</span> <span class="char">'b'</span><span class="special">));</span>
137</pre>
138</div>
139<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
140<td align="left"></td>
141<td align="right"><div class="copyright-footer">Copyright © 2001-2006, 2011, 2012 Joel de Guzman,
142      Dan Marsden, Tobias Schwinger<p>
143        Distributed under the Boost Software License, Version 1.0. (See accompanying
144        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>)
145      </p>
146</div></td>
147</tr></table>
148<hr>
149<div class="spirit-nav">
150<a accesskey="p" href="join.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="pop_back.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
151</div>
152</body>
153</html>
154