feedc0de/boost_fusion
1
0
Fork 0
forked from boostorg/fusion
Code Pull Requests Activity

adding fusion docs and tests

Browse Source 
[SVN r34920]
This commit is contained in:
Joel de Guzman
2006-08-22 15:57:13 +00:00
parent 75b9d13a88
commit c31253d8c1
351 changed files with 42280 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

245
doc/html/fusion/iterators/concepts/bidirectional_iterator.html Normal file
View File

@ -0,0 +1,245 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Bidirectional
Iterator</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<link rel="start" href="../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../concepts.html" title="Concepts">
<link rel="prev" href="forward_iterator.html" title="Forward
Iterator">
<link rel="next" href="random_access_iterator.html" title="Random
Access Iterator">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<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="../../../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="forward_iterator.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="random_access_iterator.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.iterators.concepts.bidirectional_iterator"></a><a href="bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a></h4></div></div></div>
<a name="fusion.iterators.concepts.bidirectional_iterator.description"></a><h5>
<a name="id454262"></a>
<a href="bidirectional_iterator.html#fusion.iterators.concepts.bidirectional_iterator.description">Description</a>
</h5>
<p>
A Bidirectional Iterator traverses a <a href="../../sequences.html" title="Sequences">Sequence</a>
allowing movement in either direction one element at a time.
</p>
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">i</span></tt></span></dt>
<dd>
A Bidirectional Iterator
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">I</span></tt></span></dt>
<dd>
A Bidirectional Iterator type
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">M</span></tt></span></dt>
<dd>
An <a href="http://www.boost.org/libs/mpl/index.html" target="_top">MPL</a>
integral constant
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">N</span></tt></span></dt>
<dd>
An integral constant
</dd>
</dl>
</div>
<a name="fusion.iterators.concepts.bidirectional_iterator.refinement_of"></a><h5>
<a name="id454388"></a>
<a href="bidirectional_iterator.html#fusion.iterators.concepts.bidirectional_iterator.refinement_of">Refinement
of</a>
</h5>
<p>
<a href="forward_iterator.html" title="Forward
Iterator">Forward Iterator</a>
</p>
<a name="fusion.iterators.concepts.bidirectional_iterator.expression_requirements"></a><h5>
<a name="id454430"></a>
<a href="bidirectional_iterator.html#fusion.iterators.concepts.bidirectional_iterator.expression_requirements">Expression
requirements</a>
</h5>
<p>
In addition to the requirements defined in <a href="forward_iterator.html" title="Forward
Iterator">Forward
Iterator</a>, the following expressions must be valid:
</p>
<div class="informaltable">
<h4>
<a name="id454468"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Expression</th>
<th>Return type</th>
<th>Runtime
Complexity</th>
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><a href="../functions/next.html" title="next"><tt class="computeroutput"><span class="identifier">next</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td><a href="bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a></td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../functions/prior.html" title="prior"><tt class="computeroutput"><span class="identifier">prior</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td><a href="bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a></td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../functions/advance_c.html" title="advance_c"><tt class="computeroutput"><span class="identifier">advance_c</span></tt></a><span class="special">&lt;</span><span class="identifier">N</span><span class="special">&gt;(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td><a href="bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a></td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../functions/advance.html" title="advance"><tt class="computeroutput"><span class="identifier">advance</span></tt></a><span class="special">&lt;</span><span class="identifier">M</span><span class="special">&gt;(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td><a href="bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a></td>
<td>Constant</td>
</tr>
</tbody>
</table>
</div>
<a name="fusion.iterators.concepts.bidirectional_iterator.meta_expressions"></a><h5>
<a name="id454740"></a>
<a href="bidirectional_iterator.html#fusion.iterators.concepts.bidirectional_iterator.meta_expressions">Meta
Expressions</a>
</h5>
<div class="informaltable">
<h4>
<a name="id454762"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Expression</th>
<th>Compile Time Complexity</th>
</tr></thead>
<tbody><tr>
<td><tt class="computeroutput"><a href="../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">I</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td>Amortized constant
time</td>
</tr></tbody>
</table>
</div>
<a name="fusion.iterators.concepts.bidirectional_iterator.expression_semantics"></a><h5>
<a name="id454862"></a>
<a href="bidirectional_iterator.html#fusion.iterators.concepts.bidirectional_iterator.expression_semantics">Expression
Semantics</a>
</h5>
<p>
The semantics of an expression are defined only where they differ from,
or are not defined in <a href="forward_iterator.html" title="Forward
Iterator">Forward
Iterator</a>
</p>
<div class="informaltable">
<h4>
<a name="id454900"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Expression</th>
<th>Semantics</th>
</tr></thead>
<tbody><tr>
<td><tt class="computeroutput"><a href="../functions/prior.html" title="prior"><tt class="computeroutput"><span class="identifier">prior</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td>An
iterator to the element preceding <tt class="computeroutput"><span class="identifier">i</span></tt>
</td>
</tr></tbody>
</table>
</div>
<a name="fusion.iterators.concepts.bidirectional_iterator.invariants"></a><h5>
<a name="id454990"></a>
<a href="bidirectional_iterator.html#fusion.iterators.concepts.bidirectional_iterator.invariants">Invariants</a>
</h5>
<p>
In addition to the invariants of <a href="forward_iterator.html" title="Forward
Iterator">Forward
Iterator</a>, the following invariants always hold:
</p>
<div class="itemizedlist"><ul type="disc">
<li><tt class="computeroutput"><a href="../functions/prior.html" title="prior"><tt class="computeroutput"><span class="identifier">prior</span></tt></a><span class="special">(</span><a href="../functions/next.html" title="next"><tt class="computeroutput"><span class="identifier">next</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">))</span><EFBFBD><span class="special">==</span><EFBFBD><span class="identifier">i</span><EFBFBD><span class="special">&amp;&amp;</span><EFBFBD><a href="../functions/prior.html" title="prior"><tt class="computeroutput"><span class="identifier">prior</span></tt></a><span class="special">(</span><a href="../functions/next.html" title="next"><tt class="computeroutput"><span class="identifier">next</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">))</span><EFBFBD><span class="special">==</span><EFBFBD><a href="../functions/next.html" title="next"><tt class="computeroutput"><span class="identifier">next</span></tt></a><span class="special">(</span><a href="../functions/prior.html" title="prior"><tt class="computeroutput"><span class="identifier">prior</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">))</span></tt></li>
<li><tt class="computeroutput"><a href="../functions/prior.html" title="prior"><tt class="computeroutput"><span class="identifier">prior</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span><EFBFBD><span class="special">==</span><EFBFBD><a href="../functions/advance_c.html" title="advance_c"><tt class="computeroutput"><span class="identifier">advance_c</span></tt></a><span class="special">&lt;-</span><span class="number">1</span><span class="special">&gt;(</span><span class="identifier">i</span><span class="special">)</span></tt></li>
<li>
Using <tt class="computeroutput"><a href="../functions/prior.html" title="prior"><tt class="computeroutput"><span class="identifier">prior</span></tt></a></tt> to traverse a sequence
will never return a previously seen position
</li>
</ul></div>
<a name="fusion.iterators.concepts.bidirectional_iterator.models"></a><h5>
<a name="id455328"></a>
<a href="bidirectional_iterator.html#fusion.iterators.concepts.bidirectional_iterator.models">Models</a>
</h5>
<div class="itemizedlist"><ul type="disc">
<li>
<a href="../../sequences/adapted/std__pair.html" title="std::pair"><tt class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/adapted/boost__array.html" title="boost::array"><tt class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/views/iterator_range.html" title="iterator_range"><tt class="computeroutput"><span class="identifier">iterator_range</span></tt></a>
(where adapted sequence is a <a href="../../sequences/concepts/bidirectional_sequence.html" title="Bidirectional
Sequence">Bidirectional
Sequence</a>)
</li>
<li>
<a href="../../sequences/views/transform_view.html" title="transform_view"><tt class="computeroutput"><span class="identifier">transform_view</span></tt></a>
(where adapted sequence is a <a href="../../sequences/concepts/bidirectional_sequence.html" title="Bidirectional
Sequence">Bidirectional
Sequence</a>)
</li>
<li><a href="../../sequences/views/reverse_view.html" title="reverse_view"><tt class="computeroutput"><span class="identifier">reverse_view</span></tt></a></li>
</ul></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small>Copyright <20> 2001-2005 Joel de Guzman, Dan Marsden</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="forward_iterator.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="random_access_iterator.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

353
doc/html/fusion/iterators/concepts/forward_iterator.html Normal file
View File

@ -0,0 +1,353 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Forward
Iterator</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<link rel="start" href="../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../concepts.html" title="Concepts">
<link rel="prev" href="../concepts.html" title="Concepts">
<link rel="next" href="bidirectional_iterator.html" title="Bidirectional
Iterator">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<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="../../../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../concepts.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="bidirectional_iterator.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.iterators.concepts.forward_iterator"></a><a href="forward_iterator.html" title="Forward
Iterator">Forward
Iterator</a></h4></div></div></div>
<a name="fusion.iterators.concepts.forward_iterator.description"></a><h5>
<a name="id451734"></a>
<a href="forward_iterator.html#fusion.iterators.concepts.forward_iterator.description">Description</a>
</h5>
<p>
A Forward Iterator traverses a <a href="../../sequences.html" title="Sequences">Sequence</a>
allowing movement in only one direction through it's elements, one element
at a time.
</p>
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">i</span></tt>,
<tt class="computeroutput"><span class="identifier">j</span></tt></span></dt>
<dd>
Forward Iterators
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">I</span></tt>,
<tt class="computeroutput"><span class="identifier">J</span></tt></span></dt>
<dd>
Forward Iterator types
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">M</span></tt></span></dt>
<dd>
An <a href="http://www.boost.org/libs/mpl/index.html" target="_top">MPL</a>
integral constant
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">N</span></tt></span></dt>
<dd>
An integral constant
</dd>
</dl>
</div>
<a name="fusion.iterators.concepts.forward_iterator.expression_requirements"></a><h5>
<a name="id451883"></a>
<a href="forward_iterator.html#fusion.iterators.concepts.forward_iterator.expression_requirements">Expression
requirements</a>
</h5>
<p>
A type models Forward Iterator if, in addition to being CopyConstructable,
the following expressions are valid:
</p>
<div class="informaltable">
<h4>
<a name="id451912"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Expression</th>
<th>Return type</th>
<th>Runtime
Complexity</th>
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><a href="../functions/next.html" title="next"><tt class="computeroutput"><span class="identifier">next</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td><a href="forward_iterator.html" title="Forward
Iterator">Forward Iterator</a></td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">i</span><EFBFBD><span class="special">==</span><EFBFBD><span class="identifier">j</span></tt></td>
<td>Convertible to
bool</td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">i</span><EFBFBD><span class="special">!=</span><EFBFBD><span class="identifier">j</span></tt></td>
<td>Convertible to
bool</td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../functions/advance_c.html" title="advance_c"><tt class="computeroutput"><span class="identifier">advance_c</span></tt></a><span class="special">&lt;</span><span class="identifier">N</span><span class="special">&gt;(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td><a href="forward_iterator.html" title="Forward
Iterator">Forward Iterator</a></td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../functions/advance.html" title="advance"><tt class="computeroutput"><span class="identifier">advance</span></tt></a><span class="special">&lt;</span><span class="identifier">M</span><span class="special">&gt;(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td><a href="forward_iterator.html" title="Forward
Iterator">Forward Iterator</a></td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../functions/distance.html" title="distance"><tt class="computeroutput"><span class="identifier">distance</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">,</span><EFBFBD><span class="identifier">j</span><span class="special">)</span></tt></td>
<td><tt class="computeroutput"><a href="../metafunctions/distance.html" title="distance"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">distance</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span><EFBFBD><span class="identifier">J</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../functions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">deref</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td><tt class="computeroutput"><a href="../metafunctions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">deref</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="special">*</span><span class="identifier">i</span></tt></td>
<td><tt class="computeroutput"><a href="../metafunctions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">deref</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td>Constant</td>
</tr>
</tbody>
</table>
</div>
<a name="fusion.iterators.concepts.forward_iterator.meta_expressions"></a><h5>
<a name="id452487"></a>
<a href="forward_iterator.html#fusion.iterators.concepts.forward_iterator.meta_expressions">Meta
Expressions</a>
</h5>
<div class="informaltable">
<h4>
<a name="id452508"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Expression</th>
<th>Compile Time Complexity</th>
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><a href="../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">I</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td>Amortized constant
time</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../metafunctions/equal_to.html" title="equal_to"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">equal_to</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span><EFBFBD><span class="identifier">J</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td>Amortized constant
time</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../metafunctions/advance_c.html" title="advance_c"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">advance_c</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span><EFBFBD><span class="identifier">N</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td>Linear</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../metafunctions/advance.html" title="advance"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">advance</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><EFBFBD><span class="special">,</span><span class="identifier">M</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td>Linear</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../metafunctions/distance.html" title="distance"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">distance</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><EFBFBD><span class="special">,</span><span class="identifier">J</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td>Linear</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../metafunctions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">deref</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td>Amortized constant
time</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../metafunctions/value_of.html" title="value_of"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">value_of</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td>Amortized constant
time</td>
</tr>
</tbody>
</table>
</div>
<a name="fusion.iterators.concepts.forward_iterator.expression_semantics"></a><h5>
<a name="id453005"></a>
<a href="forward_iterator.html#fusion.iterators.concepts.forward_iterator.expression_semantics">Expression
Semantics</a>
</h5>
<div class="informaltable">
<h4>
<a name="id453027"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Expression</th>
<th>Semantics</th>
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><a href="../functions/next.html" title="next"><tt class="computeroutput"><span class="identifier">next</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td>An
iterator to the element following <tt class="computeroutput"><span class="identifier">i</span></tt>
</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">i</span><EFBFBD><span class="special">==</span><EFBFBD><span class="identifier">j</span></tt></td>
<td>Iterator equality
comparison</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">i</span><EFBFBD><span class="special">!=</span><EFBFBD><span class="identifier">j</span></tt></td>
<td>Iterator inequality
comparison</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../functions/advance_c.html" title="advance_c"><tt class="computeroutput"><span class="identifier">advance_c</span></tt></a><span class="special">&lt;</span><span class="identifier">N</span><span class="special">&gt;(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td>An
iterator n elements after <tt class="computeroutput"><span class="identifier">i</span></tt>
in the sequence</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../functions/advance.html" title="advance"><tt class="computeroutput"><span class="identifier">advance</span></tt></a><span class="special">&lt;</span><span class="identifier">M</span><span class="special">&gt;(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td>Equivalent
to <tt class="computeroutput"><span class="identifier">advance_c</span><span class="special">&lt;</span><span class="identifier">M</span><span class="special">::</span><span class="identifier">value</span><span class="special">&gt;(</span><span class="identifier">i</span><span class="special">)</span></tt>
</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../functions/distance.html" title="distance"><tt class="computeroutput"><span class="identifier">distance</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">,</span><EFBFBD><span class="identifier">j</span><span class="special">)</span></tt></td>
<td>The
number of elements between <tt class="computeroutput"><span class="identifier">i</span></tt>
and <tt class="computeroutput"><span class="identifier">j</span></tt>
</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../functions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">deref</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td>The
element at position<tt class="computeroutput"><span class="identifier">i</span></tt>
</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="special">*</span><span class="identifier">i</span></tt></td>
<td>Equivalent
to <tt class="computeroutput"><span class="identifier">deref</span><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></tt>
</td>
</tr>
</tbody>
</table>
</div>
<a name="fusion.iterators.concepts.forward_iterator.invariants"></a><h5>
<a name="id453505"></a>
<a href="forward_iterator.html#fusion.iterators.concepts.forward_iterator.invariants">Invariants</a>
</h5>
<p>
The following invariants always hold:
</p>
<div class="itemizedlist"><ul type="disc">
<li><tt class="computeroutput"><span class="special">!(</span><span class="identifier">i</span><EFBFBD><span class="special">==</span><EFBFBD><span class="identifier">j</span><span class="special">)</span><EFBFBD><span class="special">==</span><EFBFBD><span class="special">(</span><span class="identifier">i</span><EFBFBD><span class="special">!=</span><EFBFBD><span class="identifier">j</span><span class="special">)</span></tt></li>
<li><tt class="computeroutput"><a href="../functions/next.html" title="next"><tt class="computeroutput"><span class="identifier">next</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span><EFBFBD><span class="special">==</span><EFBFBD><a href="../functions/advance_c.html" title="advance_c"><tt class="computeroutput"><span class="identifier">advance_c</span></tt></a><span class="special">&lt;</span><span class="number">1</span><span class="special">&gt;(</span><span class="identifier">i</span><span class="special">)</span></tt></li>
<li><tt class="computeroutput"><a href="../functions/distance.html" title="distance"><tt class="computeroutput"><span class="identifier">distance</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">,</span><EFBFBD><a href="../functions/advance_c.html" title="advance_c"><tt class="computeroutput"><span class="identifier">advance_c</span></tt></a><span class="special">&lt;</span><span class="identifier">N</span><span class="special">&gt;(</span><span class="identifier">i</span><span class="special">))</span><EFBFBD><span class="special">==</span><EFBFBD><span class="identifier">N</span></tt></li>
<li>
Using <tt class="computeroutput"><a href="../functions/next.html" title="next"><tt class="computeroutput"><span class="identifier">next</span></tt></a></tt> to traverse the
sequence will never return to a previously seen position
</li>
<li>
<tt class="computeroutput"><a href="../functions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">deref</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></tt>
is equivalent to <tt class="computeroutput"><span class="special">*</span><span class="identifier">i</span></tt>
</li>
<li>
If <tt class="computeroutput"><span class="identifier">i</span><EFBFBD><span class="special">==</span><EFBFBD><span class="identifier">j</span></tt> then <tt class="computeroutput"><span class="special">*</span><span class="identifier">i</span></tt> is equivalent to <tt class="computeroutput"><span class="special">*</span><span class="identifier">j</span></tt>
</li>
</ul></div>
<a name="fusion.iterators.concepts.forward_iterator.models"></a><h5>
<a name="id453921"></a>
<a href="forward_iterator.html#fusion.iterators.concepts.forward_iterator.models">Models</a>
</h5>
<div class="itemizedlist"><ul type="disc">
<li>
<a href="../../sequences/adapted/std__pair.html" title="std::pair"><tt class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/adapted/boost__array.html" title="boost::array"><tt class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/containers/cons.html" title="cons"><tt class="computeroutput"><span class="identifier">cons</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/containers/list.html" title="list"><tt class="computeroutput"><span class="identifier">list</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/containers/set.html" title="set"><tt class="computeroutput"><span class="identifier">set</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/containers/map.html" title="map"><tt class="computeroutput"><span class="identifier">map</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/views/single_view.html" title="single_view"><tt class="computeroutput"><span class="identifier">single_view</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/views/filter_view.html" title="filter_view"><tt class="computeroutput"><span class="identifier">filter_view</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/views/iterator_range.html" title="iterator_range"><tt class="computeroutput"><span class="identifier">iterator_range</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/views/joint_view.html" title="joint_view"><tt class="computeroutput"><span class="identifier">joint_view</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/views/transform_view.html" title="transform_view"><tt class="computeroutput"><span class="identifier">transform_view</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/views/reverse_view.html" title="reverse_view"><tt class="computeroutput"><span class="identifier">reverse_view</span></tt></a>
iterator
</li>
</ul></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small>Copyright <20> 2001-2005 Joel de Guzman, Dan Marsden</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../concepts.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="bidirectional_iterator.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

216
doc/html/fusion/iterators/concepts/random_access_iterator.html Normal file
View File

@ -0,0 +1,216 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Random
Access Iterator</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<link rel="start" href="../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../concepts.html" title="Concepts">
<link rel="prev" href="bidirectional_iterator.html" title="Bidirectional
Iterator">
<link rel="next" href="../functions.html" title="Functions">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<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="../../../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="bidirectional_iterator.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../functions.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.iterators.concepts.random_access_iterator"></a><a href="random_access_iterator.html" title="Random
Access Iterator">Random
Access Iterator</a></h4></div></div></div>
<a name="fusion.iterators.concepts.random_access_iterator.description"></a><h5>
<a name="id455540"></a>
<a href="random_access_iterator.html#fusion.iterators.concepts.random_access_iterator.description">Description</a>
</h5>
<p>
A Random Access Iterator traverses a <a href="../../sequences.html" title="Sequences">Sequence</a>
moving in either direction, permitting efficient arbitrary distance movements
back and forward through the sequence.
</p>
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">i</span></tt>,
<tt class="computeroutput"><span class="identifier">j</span></tt></span></dt>
<dd>
Random Access Iterators
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">I</span></tt>,
<tt class="computeroutput"><span class="identifier">J</span></tt></span></dt>
<dd>
Random Access Iterator types
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">M</span></tt></span></dt>
<dd>
An <a href="http://www.boost.org/libs/mpl/index.html" target="_top">MPL</a>
integral constant
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">N</span></tt></span></dt>
<dd>
An integral constant
</dd>
</dl>
</div>
<a name="fusion.iterators.concepts.random_access_iterator.refinement_of"></a><h5>
<a name="id455688"></a>
<a href="random_access_iterator.html#fusion.iterators.concepts.random_access_iterator.refinement_of">Refinement
of</a>
</h5>
<p>
<a href="bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a>
</p>
<a name="fusion.iterators.concepts.random_access_iterator.expression_requirements"></a><h5>
<a name="id455728"></a>
<a href="random_access_iterator.html#fusion.iterators.concepts.random_access_iterator.expression_requirements">Expression
requirements</a>
</h5>
<p>
In addition to the requirements defined in <a href="bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a>, the following expressions must be valid:
</p>
<div class="informaltable">
<h4>
<a name="id455766"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Expression</th>
<th>Return type</th>
<th>Runtime
Complexity</th>
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><a href="../functions/next.html" title="next"><tt class="computeroutput"><span class="identifier">next</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td><a href="random_access_iterator.html" title="Random
Access Iterator">Random
Access Iterator</a></td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../functions/prior.html" title="prior"><tt class="computeroutput"><span class="identifier">prior</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td><a href="random_access_iterator.html" title="Random
Access Iterator">Random
Access Iterator</a></td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../functions/advance_c.html" title="advance_c"><tt class="computeroutput"><span class="identifier">advance_c</span></tt></a><span class="special">&lt;</span><span class="identifier">N</span><span class="special">&gt;(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td><a href="random_access_iterator.html" title="Random
Access Iterator">Random
Access Iterator</a></td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../functions/advance.html" title="advance"><tt class="computeroutput"><span class="identifier">advance</span></tt></a><span class="special">&lt;</span><span class="identifier">M</span><span class="special">&gt;(</span><span class="identifier">i</span><span class="special">)</span></tt></td>
<td><a href="random_access_iterator.html" title="Random
Access Iterator">Random
Access Iterator</a></td>
<td>Constant</td>
</tr>
</tbody>
</table>
</div>
<a name="fusion.iterators.concepts.random_access_iterator.meta_expressions"></a><h5>
<a name="id456036"></a>
<a href="random_access_iterator.html#fusion.iterators.concepts.random_access_iterator.meta_expressions">Meta
Expressions</a>
</h5>
<div class="informaltable">
<h4>
<a name="id456058"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Expression</th>
<th>Compile Time Complexity</th>
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><a href="../metafunctions/advance_c.html" title="advance_c"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">advance_c</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span><EFBFBD><span class="identifier">N</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td>Amortized constant
time</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../metafunctions/advance.html" title="advance"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">advance</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span><EFBFBD><span class="identifier">M</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td>Amortized constant
time</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../metafunctions/distance.html" title="distance"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">distance</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><EFBFBD><span class="special">,</span><span class="identifier">J</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td>Amortized constant
time</td>
</tr>
</tbody>
</table>
</div>
<a name="fusion.iterators.concepts.random_access_iterator.models"></a><h5>
<a name="id456304"></a>
<a href="random_access_iterator.html#fusion.iterators.concepts.random_access_iterator.models">Models</a>
</h5>
<div class="itemizedlist"><ul type="disc">
<li>
<a href="../../sequences/containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/adapted/std__pair.html" title="std::pair"><tt class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/adapted/boost__array.html" title="boost::array"><tt class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span></tt></a>
iterator
</li>
<li>
<a href="../../sequences/views/iterator_range.html" title="iterator_range"><tt class="computeroutput"><span class="identifier">iterator_range</span></tt></a>
iterator (where adapted sequence is a <a href="../../sequences/concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a>)
</li>
<li>
<a href="../../sequences/views/transform_view.html" title="transform_view"><tt class="computeroutput"><span class="identifier">transform_view</span></tt></a>
iterator (where adapted sequence is a <a href="../../sequences/concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a>)
</li>
<li>
<a href="../../sequences/views/reverse_view.html" title="reverse_view"><tt class="computeroutput"><span class="identifier">reverse_view</span></tt></a>
iterator (where adapted sequence is a <a href="../../sequences/concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a>)
</li>
</ul></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small>Copyright <20> 2001-2005 Joel de Guzman, Dan Marsden</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="bidirectional_iterator.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../functions.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>