blob: 6a8da83281bab3d31de17fad7c1dd1c26ca31ac7 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>zip_view</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Fusion 2.0">
<link rel="up" href="../view.html" title="View">
<link rel="prev" href="joint_view.html" title="joint_view">
<link rel="next" href="transform_view.html" title="transform_view">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="joint_view.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../view.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="transform_view.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="fusion.view.zip_view"></a><a class="link" href="zip_view.html" title="zip_view">zip_view</a>
</h3></div></div></div>
<a name="fusion.view.zip_view.description"></a><h5>
<a name="id953494"></a>
<a class="link" href="zip_view.html#fusion.view.zip_view.description">Description</a>
</h5>
<p>
<code class="computeroutput"><span class="identifier">zip_view</span></code> presents a view
which iterates over a collection of <a class="link" href="../sequence.html" title="Sequence">Sequence</a>(s)
in parallel. A <code class="computeroutput"><span class="identifier">zip_view</span></code> is
constructed from a <a class="link" href="../sequence.html" title="Sequence">Sequence</a> of references
to the component <span class="underline">_sequence</span>_s.
</p>
<a name="fusion.view.zip_view.header"></a><h5>
<a name="id953540"></a>
<a class="link" href="zip_view.html#fusion.view.zip_view.header">Header</a>
</h5>
<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">view</span><span class="special">/</span><span class="identifier">zip_view</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<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_view</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.view.zip_view.synopsis"></a><h5>
<a name="id953648"></a>
<a class="link" href="zip_view.html#fusion.view.zip_view.synopsis">Synopsis</a>
</h5>
<pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequences</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">zip_view</span><span class="special">;</span>
</pre>
<a name="fusion.view.zip_view.template_parameters"></a><h5>
<a name="id953700"></a>
<a class="link" href="zip_view.html#fusion.view.zip_view.template_parameters">Template parameters</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Description
</p>
</th>
<th>
<p>
Default
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Sequences</span></code>
</p>
</td>
<td>
<p>
A <a class="link" href="../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward
Sequence</a> of references to other Fusion <span class="underline">_sequence</span>_s
</p>
</td>
<td>
</td>
</tr></tbody>
</table></div>
<a name="fusion.view.zip_view.model_of"></a><h5>
<a name="id953794"></a>
<a class="link" href="zip_view.html#fusion.view.zip_view.model_of">Model of</a>
</h5>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<a class="link" href="../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward Sequence</a>,
<a class="link" href="../sequence/concepts/bidirectional_sequence.html" title="Bidirectional Sequence">Bidirectional
Sequence</a> or <a class="link" href="../sequence/concepts/random_access_sequence.html" title="Random Access Sequence">Random
Access Sequence</a> depending on the traversal characteristics (see
<a class="link" href="../sequence/concepts.html#fusion.sequence.concepts.traversal">Sequence Traversal
Concept</a>) of its underlying sequence.
</li></ul></div>
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><code class="computeroutput"><span class="identifier">ZV</span></code></span></dt>
<dd><p>
A <code class="computeroutput"><span class="identifier">zip_view</span></code> type
</p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">s</span></code></span></dt>
<dd><p>
An instance of <code class="computeroutput"><span class="identifier">Sequences</span></code>
</p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">zv1</span></code>, <code class="computeroutput"><span class="identifier">zv2</span></code></span></dt>
<dd><p>
Instances of <code class="computeroutput"><span class="identifier">ZV</span></code>
</p></dd>
</dl>
</div>
<a name="fusion.view.zip_view.expression_semantics"></a><h5>
<a name="id953932"></a>
<a class="link" href="zip_view.html#fusion.view.zip_view.expression_semantics">Expression Semantics</a>
</h5>
<p>
Semantics of an expression is defined only where it differs from, or is not
defined in <a class="link" href="../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward
Sequence</a>.
</p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Expression
</p>
</th>
<th>
<p>
Semantics
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">ZV</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code>
</p>
</td>
<td>
<p>
Creates a <code class="computeroutput"><span class="identifier">zip_view</span></code>
given a sequence of references to the component <span class="underline">_sequence</span>_s.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">ZV</span><span class="special">(</span><span class="identifier">zv1</span><span class="special">)</span></code>
</p>
</td>
<td>
<p>
Copy constructs a <code class="computeroutput"><span class="identifier">zip_view</span></code>
from another <code class="computeroutput"><span class="identifier">zip_view</span></code>,
<code class="computeroutput"><span class="identifier">zv</span></code>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">zv1</span> <span class="special">=</span>
<span class="identifier">zv2</span></code>
</p>
</td>
<td>
<p>
Assigns to a <code class="computeroutput"><span class="identifier">zip_view</span></code>,
<code class="computeroutput"><span class="identifier">zv</span></code>, from another
<code class="computeroutput"><span class="identifier">zip_view</span></code>, <code class="computeroutput"><span class="identifier">zv2</span></code>.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.view.zip_view.example"></a><h5>
<a name="id954157"></a>
<a class="link" href="zip_view.html#fusion.view.zip_view.example">Example</a>
</h5>
<pre class="programlisting"><span class="keyword">typedef</span> <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">int</span><span class="special">&gt;</span> <span class="identifier">vec1</span><span class="special">;</span>
<span class="keyword">typedef</span> <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">char</span><span class="special">,</span><span class="keyword">char</span><span class="special">&gt;</span> <span class="identifier">vec2</span><span class="special">;</span>
<span class="identifier">vec1</span> <span class="identifier">v1</span><span class="special">(</span><span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">);</span>
<span class="identifier">vec2</span> <span class="identifier">v2</span><span class="special">(</span><span class="char">'a'</span><span class="special">,</span><span class="char">'b'</span><span class="special">);</span>
<span class="keyword">typedef</span> <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="identifier">vec1</span><span class="special">&amp;,</span> <span class="identifier">vec2</span><span class="special">&amp;&gt;</span> <span class="identifier">sequences</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">zip_view</span><span class="special">&lt;</span><span class="identifier">sequences</span><span class="special">&gt;(</span><span class="identifier">sequences</span><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">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> <span class="comment">// ((1 a) (2 b))
</span></pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2001-2007 Joel de Guzman, Dan Marsden, Tobias
Schwinger<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="joint_view.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../view.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="transform_view.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>