Files
boost_fusion/doc/html/fusion/view/iterator_range.html
Joel de Guzman d004046aa5 Merge from Trunk
[SVN r49252]
2008-10-10 15:05:47 +00:00

262 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.66.1">
<link rel="start" 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" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="fusion.view.iterator_range"></a><a href="iterator_range.html" title="iterator_range">iterator_range</a></h3></div></div></div>
<a name="fusion.view.iterator_range.description"></a><h4>
<a name="id565688"></a>
<a href="iterator_range.html#fusion.view.iterator_range.description">Description</a>
</h4>
<p>
<tt class="computeroutput"><span class="identifier">iterator_range</span></tt> presents a
sub-range of its underlying sequence delimited by a pair of iterators.
</p>
<a name="fusion.view.iterator_range.header"></a><h4>
<a name="id565729"></a>
<a href="iterator_range.html#fusion.view.iterator_range.header">Header</a>
</h4>
<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><h4>
<a name="id565887"></a>
<a href="iterator_range.html#fusion.view.iterator_range.synopsis">Synopsis</a>
</h4>
<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><h4>
<a name="id565986"></a>
<a href="iterator_range.html#fusion.view.iterator_range.template_parameters">Template parameters</a>
</h4>
<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>
<tt class="computeroutput"><span class="identifier">First</span></tt>
</p>
</td>
<td>
<p>
A fusion <a href="../iterator.html" title="Iterator">Iterator</a>
</p>
</td>
<td>
<p>
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">Last</span></tt>
</p>
</td>
<td>
<p>
A fusion <a 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><h4>
<a name="id566140"></a>
<a href="iterator_range.html#fusion.view.iterator_range.model_of">Model of</a>
</h4>
<div class="itemizedlist"><ul type="disc"><li>
<a href="../sequence/concepts/forward_sequence.html" title="Forward
Sequence">Forward Sequence</a>,
<a href="../sequence/concepts/bidirectional_sequence.html" title="Bidirectional
Sequence">Bidirectional
Sequence</a> or <a href="../sequence/concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a> depending on the traversal characteristics (see
<a 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"><tt class="computeroutput"><span class="identifier">IR</span></tt></span></dt>
<dd><p>
An <tt class="computeroutput"><span class="identifier">iterator_range</span></tt> type
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">f</span></tt></span></dt>
<dd><p>
An instance of <tt class="computeroutput"><span class="identifier">First</span></tt>
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">l</span></tt></span></dt>
<dd><p>
An instance of <tt class="computeroutput"><span class="identifier">Last</span></tt>
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">ir</span></tt>,
<tt class="computeroutput"><span class="identifier">ir2</span></tt></span></dt>
<dd><p>
Instances of <tt class="computeroutput"><span class="identifier">iterator_range</span></tt>
</p></dd>
</dl>
</div>
<a name="fusion.view.iterator_range.expression_semantics"></a><h4>
<a name="id566370"></a>
<a href="iterator_range.html#fusion.view.iterator_range.expression_semantics">Expression
Semantics</a>
</h4>
<p>
Semantics of an expression is defined only where it differs from, or is not
defined in <a 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>
<tt 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></tt>
</p>
</td>
<td>
<p>
Creates an <tt class="computeroutput"><span class="identifier">iterator_range</span></tt>
given iterators, <tt class="computeroutput"><span class="identifier">f</span></tt>
and <tt class="computeroutput"><span class="identifier">l</span></tt>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">IR</span><span class="special">(</span><span class="identifier">ir</span><span class="special">)</span></tt>
</p>
</td>
<td>
<p>
Copy constructs an <tt class="computeroutput"><span class="identifier">iterator_range</span></tt>
from another <tt class="computeroutput"><span class="identifier">iterator_range</span></tt>,
<tt class="computeroutput"><span class="identifier">ir</span></tt>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">ir</span> <span class="special">=</span>
<span class="identifier">ir2</span></tt>
</p>
</td>
<td>
<p>
Assigns to a <tt class="computeroutput"><span class="identifier">iterator_range</span></tt>,
<tt class="computeroutput"><span class="identifier">ir</span></tt>, from another
<tt class="computeroutput"><span class="identifier">iterator_range</span></tt>,
<tt class="computeroutput"><span class="identifier">ir2</span></tt>.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.view.iterator_range.example"></a><h4>
<a name="id566706"></a>
<a href="iterator_range.html#fusion.view.iterator_range.example">Example</a>
</h4>
<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 href="../container/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></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 href="../sequence/intrinsic/metafunctions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">begin</span></tt></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 href="../sequence/intrinsic/metafunctions/end.html" title="end"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">end</span></tt></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 href="../iterator/metafunctions/next.html" title="next"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">next</span></tt></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 href="../iterator/metafunctions/prior.html" title="prior"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">prior</span></tt></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>