Files
boost_fusion/doc/html/fusion/view/iterator_range.html
2009-10-24 10:59:01 +00:00

256 lines
15 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>iterator_range</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="../../index.html" title="Chapter 1. Fusion 2.0">
<link rel="up" href="../view.html" title="View">
<link rel="prev" href="filter_view.html" title="filter_view">
<link rel="next" href="joint_view.html" title="joint_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="../../../../../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="filter_view.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../view.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="joint_view.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" title="iterator_range">
<div class="titlepage"><div><div><h3 class="title">
<a name="fusion.view.iterator_range"></a><a class="link" href="iterator_range.html" title="iterator_range">iterator_range</a>
</h3></div></div></div>
<a name="fusion.view.iterator_range.description"></a><h5>
<a name="id771397"></a>
<a class="link" href="iterator_range.html#fusion.view.iterator_range.description">Description</a>
</h5>
<p>
<code class="computeroutput"><span class="identifier">iterator_range</span></code> presents a
sub-range of its underlying sequence delimited by a pair of iterators.
</p>
<a name="fusion.view.iterator_range.header"></a><h5>
<a name="id771421"></a>
<a class="link" href="iterator_range.html#fusion.view.iterator_range.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">iterator_range</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">iterator_range</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.view.iterator_range.synopsis"></a><h5>
<a name="id771529"></a>
<a class="link" href="iterator_range.html#fusion.view.iterator_range.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">First</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Last</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">iterator_range</span><span class="special">;</span>
</pre>
<a name="fusion.view.iterator_range.template_parameters"></a><h5>
<a name="id771594"></a>
<a class="link" href="iterator_range.html#fusion.view.iterator_range.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">First</span></code>
</p>
</td>
<td>
<p>
A fusion <a class="link" href="../iterator.html" title="Iterator">Iterator</a>
</p>
</td>
<td>
<p>
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Last</span></code>
</p>
</td>
<td>
<p>
A fusion <a class="link" href="../iterator.html" title="Iterator">Iterator</a>
</p>
</td>
<td>
<p>
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.view.iterator_range.model_of"></a><h5>
<a name="id771717"></a>
<a class="link" href="iterator_range.html#fusion.view.iterator_range.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" title="Notation">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><code class="computeroutput"><span class="identifier">IR</span></code></span></dt>
<dd><p>
An <code class="computeroutput"><span class="identifier">iterator_range</span></code> type
</p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">f</span></code></span></dt>
<dd><p>
An instance of <code class="computeroutput"><span class="identifier">First</span></code>
</p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">l</span></code></span></dt>
<dd><p>
An instance of <code class="computeroutput"><span class="identifier">Last</span></code>
</p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">ir</span></code>,
<code class="computeroutput"><span class="identifier">ir2</span></code></span></dt>
<dd><p>
Instances of <code class="computeroutput"><span class="identifier">iterator_range</span></code>
</p></dd>
</dl>
</div>
<a name="fusion.view.iterator_range.expression_semantics"></a><h5>
<a name="id771873"></a>
<a class="link" href="iterator_range.html#fusion.view.iterator_range.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">IR</span><span class="special">(</span><span class="identifier">f</span><span class="special">,</span> <span class="identifier">l</span><span class="special">)</span></code>
</p>
</td>
<td>
<p>
Creates an <code class="computeroutput"><span class="identifier">iterator_range</span></code>
given iterators, <code class="computeroutput"><span class="identifier">f</span></code>
and <code class="computeroutput"><span class="identifier">l</span></code>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">IR</span><span class="special">(</span><span class="identifier">ir</span><span class="special">)</span></code>
</p>
</td>
<td>
<p>
Copy constructs an <code class="computeroutput"><span class="identifier">iterator_range</span></code>
from another <code class="computeroutput"><span class="identifier">iterator_range</span></code>,
<code class="computeroutput"><span class="identifier">ir</span></code>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">ir</span> <span class="special">=</span>
<span class="identifier">ir2</span></code>
</p>
</td>
<td>
<p>
Assigns to a <code class="computeroutput"><span class="identifier">iterator_range</span></code>,
<code class="computeroutput"><span class="identifier">ir</span></code>, from another
<code class="computeroutput"><span class="identifier">iterator_range</span></code>,
<code class="computeroutput"><span class="identifier">ir2</span></code>.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.view.iterator_range.example"></a><h5>
<a name="id772111"></a>
<a class="link" href="iterator_range.html#fusion.view.iterator_range.example">Example</a>
</h5>
<pre class="programlisting"><span class="keyword">char</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">s</span> <span class="special">=</span> <span class="string">"Ruby"</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">int</span><span class="special">,</span> <span class="keyword">char</span><span class="special">,</span> <span class="keyword">double</span><span class="special">,</span> <span class="keyword">char</span> <span class="keyword">const</span><span class="special">*&gt;</span> <span class="identifier">vector_type</span><span class="special">;</span>
<span class="identifier">vector_type</span> <span class="identifier">vec</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="char">'x'</span><span class="special">,</span> <span class="number">3.3</span><span class="special">,</span> <span class="identifier">s</span><span class="special">);</span>
<span class="keyword">typedef</span> <a class="link" href="../sequence/intrinsic/metafunctions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">begin</span></code></a><span class="special">&lt;</span><span class="identifier">vector_type</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">A</span><span class="special">;</span>
<span class="keyword">typedef</span> <a class="link" href="../sequence/intrinsic/metafunctions/end.html" title="end"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">end</span></code></a><span class="special">&lt;</span><span class="identifier">vector_type</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">B</span><span class="special">;</span>
<span class="keyword">typedef</span> <a class="link" href="../iterator/metafunctions/next.html" title="next"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">next</span></code></a><span class="special">&lt;</span><span class="identifier">A</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">C</span><span class="special">;</span>
<span class="keyword">typedef</span> <a class="link" href="../iterator/metafunctions/prior.html" title="prior"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">prior</span></code></a><span class="special">&lt;</span><span class="identifier">B</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">D</span><span class="special">;</span>
<span class="identifier">C</span> <span class="identifier">c</span><span class="special">(</span><span class="identifier">vec</span><span class="special">);</span>
<span class="identifier">D</span> <span class="identifier">d</span><span class="special">(</span><span class="identifier">vec</span><span class="special">);</span>
<span class="identifier">iterator_range</span><span class="special">&lt;</span><span class="identifier">C</span><span class="special">,</span> <span class="identifier">D</span><span class="special">&gt;</span> <span class="identifier">range</span><span class="special">(</span><span class="identifier">c</span><span class="special">,</span> <span class="identifier">d</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">range</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>
</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 © 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="filter_view.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../view.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="joint_view.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>