Regenerate fusion documentation.

[SVN r41607]
This commit is contained in:
Daniel James committed 2007-12-03 00:09:20 +00:00
1 parent df69f05f94
commit 59df6ee7f1
259 files changed
+7187 -7506

No files matched your search

+61 -64
View File
@@ -3,7 +3,7 @@
<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">
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<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">
@@ -14,8 +14,8 @@
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="http://beta.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://beta.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
@@ -24,35 +24,36 @@
</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="id562836"></a>
<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><h5>
<a name="id2709477"></a>
<a href="iterator_range.html#fusion.view.iterator_range.description">Description</a>
</h4>
</h5>
<p>
<tt class="computeroutput"><span class="identifier">iterator_range</span></tt> presents a
<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><h4>
<a name="id562878"></a>
<a name="fusion.view.iterator_range.header"></a><h5>
<a name="id2709515"></a>
<a href="iterator_range.html#fusion.view.iterator_range.header">Header</a>
</h4>
</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><h4>
<a name="id563036"></a>
<a name="fusion.view.iterator_range.synopsis"></a><h5>
<a name="id2709657"></a>
<a href="iterator_range.html#fusion.view.iterator_range.synopsis">Synopsis</a>
</h4>
</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><h4>
<a name="id563134"></a>
<a name="fusion.view.iterator_range.template_parameters"></a><h5>
<a name="id2709744"></a>
<a href="iterator_range.html#fusion.view.iterator_range.template_parameters">Template parameters</a>
</h4>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
@@ -80,7 +81,7 @@
<tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">First</span></tt>
<code class="computeroutput"><span class="identifier">First</span></code>
</p>
</td>
<td>
@@ -96,7 +97,7 @@
<tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">Last</span></tt>
<code class="computeroutput"><span class="identifier">Last</span></code>
</p>
</td>
<td>
@@ -111,17 +112,14 @@
</tr>
</tbody>
</table></div>
<a name="fusion.view.iterator_range.model_of"></a><h4>
<a name="id563288"></a>
<a name="fusion.view.iterator_range.model_of"></a><h5>
<a name="id2709882"></a>
<a href="iterator_range.html#fusion.view.iterator_range.model_of">Model of</a>
</h4>
</h5>
<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
<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.
@@ -129,34 +127,33 @@
<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>
<dt><span class="term"><code class="computeroutput"><span class="identifier">IR</span></code></span></dt>
<dd><p>
An <tt class="computeroutput"><span class="identifier">iterator_range</span></tt> type
An <code class="computeroutput"><span class="identifier">iterator_range</span></code> type
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">f</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">f</span></code></span></dt>
<dd><p>
An instance of <tt class="computeroutput"><span class="identifier">First</span></tt>
An instance of <code class="computeroutput"><span class="identifier">First</span></code>
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">l</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">l</span></code></span></dt>
<dd><p>
An instance of <tt class="computeroutput"><span class="identifier">Last</span></tt>
An instance of <code class="computeroutput"><span class="identifier">Last</span></code>
</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>
<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 <tt class="computeroutput"><span class="identifier">iterator_range</span></tt>
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><h4>
<a name="id563518"></a>
<a name="fusion.view.iterator_range.expression_semantics"></a><h5>
<a name="id2710087"></a>
<a href="iterator_range.html#fusion.view.iterator_range.expression_semantics">Expression
Semantics</a>
</h4>
</h5>
<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
defined in <a href="../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward
Sequence</a>.
</p>
<div class="informaltable"><table class="table">
@@ -180,62 +177,62 @@
<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>
<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 <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>.
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>
<tt class="computeroutput"><span class="identifier">IR</span><span class="special">(</span><span class="identifier">ir</span><span class="special">)</span></tt>
<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 <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>.
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>
<tt class="computeroutput"><span class="identifier">ir</span> <span class="special">=</span>
<span class="identifier">ir2</span></tt>
<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 <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>.
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><h4>
<a name="id563854"></a>
<a name="fusion.view.iterator_range.example"></a><h5>
<a name="id2710390"></a>
<a href="iterator_range.html#fusion.view.iterator_range.example">Example</a>
</h4>
</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 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="keyword">typedef</span> <a 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 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="keyword">typedef</span> <a 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 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 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 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>