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

Regenerating/reorganizing docs

Browse Source 
[SVN r40832]
This commit is contained in:
Joel de Guzman
2007-11-06 12:13:52 +00:00
parent a8ac3c3413
commit a326739705
327 changed files with 39499 additions and 209 deletions
Download Patch File Download Diff File Expand all files Collapse all files

319
doc/html/fusion/iterator/concepts/bidirectional_iterator.html Normal file
View File

@ -0,0 +1,319 @@
<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%"><tr>
<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>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="forward_iterator.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.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="random_access_iterator.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.iterator.concepts.bidirectional_iterator"></a><a href="bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a></h4></div></div></div>
<a name="fusion.iterator.concepts.bidirectional_iterator.description"></a><h5>
<a name="id471052"></a>
<a href="bidirectional_iterator.html#fusion.iterator.concepts.bidirectional_iterator.description">Description</a>
</h5>
<p>
A Bidirectional Iterator traverses a <a href="../../sequence.html" title="Sequence">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><p>
A Bidirectional Iterator
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">I</span></tt></span></dt>
<dd><p>
A Bidirectional Iterator type
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">M</span></tt></span></dt>
<dd><p>
An <a href="http://www.boost.org/libs/mpl/index.html" target="_top">MPL</a>
integral constant
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">N</span></tt></span></dt>
<dd><p>
An integral constant
</p></dd>
</dl>
</div>
<a name="fusion.iterator.concepts.bidirectional_iterator.refinement_of"></a><h5>
<a name="id471200"></a>
<a href="bidirectional_iterator.html#fusion.iterator.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.iterator.concepts.bidirectional_iterator.expression_requirements"></a><h5>
<a name="id471240"></a>
<a href="bidirectional_iterator.html#fusion.iterator.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"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Expression
</p>
</th>
<th>
<p>
Return type
</p>
</th>
<th>
<p>
Runtime Complexity
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
<a href="bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a>
</p>
</td>
<td>
<p>
Constant
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
<a href="bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a>
</p>
</td>
<td>
<p>
Constant
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
<a href="bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a>
</p>
</td>
<td>
<p>
Constant
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
<a href="bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a>
</p>
</td>
<td>
<p>
Constant
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.iterator.concepts.bidirectional_iterator.meta_expressions"></a><h5>
<a name="id471623"></a>
<a href="bidirectional_iterator.html#fusion.iterator.concepts.bidirectional_iterator.meta_expressions">Meta
Expressions</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Expression
</p>
</th>
<th>
<p>
Compile Time Complexity
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Amortized constant time
</p>
</td>
</tr></tbody>
</table></div>
<a name="fusion.iterator.concepts.bidirectional_iterator.expression_semantics"></a><h5>
<a name="id471759"></a>
<a href="bidirectional_iterator.html#fusion.iterator.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"><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"><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>
</p>
</td>
<td>
<p>
An iterator to the element preceding <tt class="computeroutput"><span class="identifier">i</span></tt>
</p>
</td>
</tr></tbody>
</table></div>
<a name="fusion.iterator.concepts.bidirectional_iterator.invariants"></a><h5>
<a name="id471904"></a>
<a href="bidirectional_iterator.html#fusion.iterator.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> <span class="special">==</span> <span class="identifier">i</span> <span class="special">&amp;&amp;</span> <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> <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><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> <span class="special">==</span> <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.iterator.concepts.bidirectional_iterator.models"></a><h5>
<a name="id472242"></a>
<a href="bidirectional_iterator.html#fusion.iterator.concepts.bidirectional_iterator.models">Models</a>
</h5>
<div class="itemizedlist"><ul type="disc">
<li>
<a href="../../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="../../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="../../container/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a>
iterator
</li>
<li>
<a href="../../view/iterator_range.html" title="iterator_range"><tt class="computeroutput"><span class="identifier">iterator_range</span></tt></a>
(where adapted sequence is a <a href="../../sequence/concepts/bidirectional_sequence.html" title="Bidirectional
Sequence">Bidirectional
Sequence</a>)
</li>
<li>
<a href="../../view/transform_view.html" title="transform_view"><tt class="computeroutput"><span class="identifier">transform_view</span></tt></a>
(where adapted sequence is a <a href="../../sequence/concepts/bidirectional_sequence.html" title="Bidirectional
Sequence">Bidirectional
Sequence</a>)
</li>
<li><a href="../../view/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-2007 Joel de Guzman, Dan Marsden, Tobias
Schwinger</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="forward_iterator.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.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="random_access_iterator.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

576
doc/html/fusion/iterator/concepts/forward_iterator.html Normal file
View File

@ -0,0 +1,576 @@
<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%"><tr>
<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>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../concepts.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.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="bidirectional_iterator.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.iterator.concepts.forward_iterator"></a><a href="forward_iterator.html" title="Forward
Iterator">Forward
Iterator</a></h4></div></div></div>
<a name="fusion.iterator.concepts.forward_iterator.description"></a><h5>
<a name="id468146"></a>
<a href="forward_iterator.html#fusion.iterator.concepts.forward_iterator.description">Description</a>
</h5>
<p>
A Forward Iterator traverses a <a href="../../sequence.html" title="Sequence">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><p>
Forward Iterators
</p></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><p>
Forward Iterator types
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">M</span></tt></span></dt>
<dd><p>
An <a href="http://www.boost.org/libs/mpl/index.html" target="_top">MPL</a>
integral constant
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">N</span></tt></span></dt>
<dd><p>
An integral constant
</p></dd>
</dl>
</div>
<a name="fusion.iterator.concepts.forward_iterator.expression_requirements"></a><h5>
<a name="id468318"></a>
<a href="forward_iterator.html#fusion.iterator.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"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Expression
</p>
</th>
<th>
<p>
Return type
</p>
</th>
<th>
<p>
Runtime Complexity
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
<a href="forward_iterator.html" title="Forward
Iterator">Forward
Iterator</a>
</p>
</td>
<td>
<p>
Constant
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">i</span> <span class="special">==</span>
<span class="identifier">j</span></tt>
</p>
</td>
<td>
<p>
Convertible to bool
</p>
</td>
<td>
<p>
Constant
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">i</span> <span class="special">!=</span>
<span class="identifier">j</span></tt>
</p>
</td>
<td>
<p>
Convertible to bool
</p>
</td>
<td>
<p>
Constant
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
<a href="forward_iterator.html" title="Forward
Iterator">Forward
Iterator</a>
</p>
</td>
<td>
<p>
Constant
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
<a href="forward_iterator.html" title="Forward
Iterator">Forward
Iterator</a>
</p>
</td>
<td>
<p>
Constant
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
<span class="identifier">j</span><span class="special">)</span></tt>
</p>
</td>
<td>
<p>
<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>
<span class="identifier">J</span><span class="special">&gt;::</span><span class="identifier">type</span></tt>
</p>
</td>
<td>
<p>
Constant
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Constant
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt class="computeroutput"><span class="special">*</span><span class="identifier">i</span></tt>
</p>
</td>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Constant
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.iterator.concepts.forward_iterator.meta_expressions"></a><h5>
<a name="id469064"></a>
<a href="forward_iterator.html#fusion.iterator.concepts.forward_iterator.meta_expressions">Meta
Expressions</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Expression
</p>
</th>
<th>
<p>
Compile Time Complexity
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Amortized constant time
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
<span class="identifier">J</span><span class="special">&gt;::</span><span class="identifier">type</span></tt>
</p>
</td>
<td>
<p>
Amortized constant time
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
<span class="identifier">N</span><span class="special">&gt;::</span><span class="identifier">type</span></tt>
</p>
</td>
<td>
<p>
Linear
</p>
</td>
</tr>
<tr>
<td>
<p>
<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><span class="identifier">M</span><span class="special">&gt;::</span><span class="identifier">type</span></tt>
</p>
</td>
<td>
<p>
Linear
</p>
</td>
</tr>
<tr>
<td>
<p>
<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><span class="identifier">J</span><span class="special">&gt;::</span><span class="identifier">type</span></tt>
</p>
</td>
<td>
<p>
Linear
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Amortized constant time
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Amortized constant time
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.iterator.concepts.forward_iterator.expression_semantics"></a><h5>
<a name="id469667"></a>
<a href="forward_iterator.html#fusion.iterator.concepts.forward_iterator.expression_semantics">Expression
Semantics</a>
</h5>
<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"><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>
</p>
</td>
<td>
<p>
An iterator to the element following <tt class="computeroutput"><span class="identifier">i</span></tt>
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">i</span> <span class="special">==</span>
<span class="identifier">j</span></tt>
</p>
</td>
<td>
<p>
Iterator equality comparison
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">i</span> <span class="special">!=</span>
<span class="identifier">j</span></tt>
</p>
</td>
<td>
<p>
Iterator inequality comparison
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
An iterator n elements after <tt class="computeroutput"><span class="identifier">i</span></tt>
in the sequence
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
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>
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
<span class="identifier">j</span><span class="special">)</span></tt>
</p>
</td>
<td>
<p>
The number of elements between <tt class="computeroutput"><span class="identifier">i</span></tt>
and <tt class="computeroutput"><span class="identifier">j</span></tt>
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
The element at position<tt class="computeroutput"><span class="identifier">i</span></tt>
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt class="computeroutput"><span class="special">*</span><span class="identifier">i</span></tt>
</p>
</td>
<td>
<p>
Equivalent to <tt class="computeroutput"><span class="identifier">deref</span><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></tt>
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.iterator.concepts.forward_iterator.invariants"></a><h5>
<a name="id470275"></a>
<a href="forward_iterator.html#fusion.iterator.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>
<span class="special">==</span> <span class="identifier">j</span><span class="special">)</span> <span class="special">==</span> <span class="special">(</span><span class="identifier">i</span> <span class="special">!=</span> <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> <span class="special">==</span> <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> <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> <span class="special">==</span> <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> <span class="special">==</span>
<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.iterator.concepts.forward_iterator.models"></a><h5>
<a name="id470699"></a>
<a href="forward_iterator.html#fusion.iterator.concepts.forward_iterator.models">Models</a>
</h5>
<div class="itemizedlist"><ul type="disc">
<li>
<a href="../../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="../../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="../../container/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a>
iterator
</li>
<li>
<a href="../../container/cons.html" title="cons"><tt class="computeroutput"><span class="identifier">cons</span></tt></a>
iterator
</li>
<li>
<a href="../../container/list.html" title="list"><tt class="computeroutput"><span class="identifier">list</span></tt></a>
iterator
</li>
<li>
<a href="../../container/set.html" title="set"><tt class="computeroutput"><span class="identifier">set</span></tt></a>
iterator
</li>
<li>
<a href="../../container/map.html" title="map"><tt class="computeroutput"><span class="identifier">map</span></tt></a>
iterator
</li>
<li>
<a href="../../view/single_view.html" title="single_view"><tt class="computeroutput"><span class="identifier">single_view</span></tt></a>
iterator
</li>
<li>
<a href="../../view/filter_view.html" title="filter_view"><tt class="computeroutput"><span class="identifier">filter_view</span></tt></a>
iterator
</li>
<li>
<a href="../../view/iterator_range.html" title="iterator_range"><tt class="computeroutput"><span class="identifier">iterator_range</span></tt></a>
iterator
</li>
<li>
<a href="../../view/joint_view.html" title="joint_view"><tt class="computeroutput"><span class="identifier">joint_view</span></tt></a>
iterator
</li>
<li>
<a href="../../view/transform_view.html" title="transform_view"><tt class="computeroutput"><span class="identifier">transform_view</span></tt></a>
iterator
</li>
<li>
<a href="../../view/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-2007 Joel de Guzman, Dan Marsden, Tobias
Schwinger</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../concepts.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.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="bidirectional_iterator.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

297
doc/html/fusion/iterator/concepts/random_access_iterator.html Normal file
View File

@ -0,0 +1,297 @@
<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%"><tr>
<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>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="bidirectional_iterator.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.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="../functions.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.iterator.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.iterator.concepts.random_access_iterator.description"></a><h5>
<a name="id472460"></a>
<a href="random_access_iterator.html#fusion.iterator.concepts.random_access_iterator.description">Description</a>
</h5>
<p>
A Random Access Iterator traverses a <a href="../../sequence.html" title="Sequence">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><p>
Random Access Iterators
</p></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><p>
Random Access Iterator types
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">M</span></tt></span></dt>
<dd><p>
An <a href="http://www.boost.org/libs/mpl/index.html" target="_top">MPL</a>
integral constant
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">N</span></tt></span></dt>
<dd><p>
An integral constant
</p></dd>
</dl>
</div>
<a name="fusion.iterator.concepts.random_access_iterator.refinement_of"></a><h5>
<a name="id472631"></a>
<a href="random_access_iterator.html#fusion.iterator.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.iterator.concepts.random_access_iterator.expression_requirements"></a><h5>
<a name="id472670"></a>
<a href="random_access_iterator.html#fusion.iterator.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"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Expression
</p>
</th>
<th>
<p>
Return type
</p>
</th>
<th>
<p>
Runtime Complexity
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
<a href="random_access_iterator.html" title="Random
Access Iterator">Random
Access Iterator</a>
</p>
</td>
<td>
<p>
Constant
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
<a href="random_access_iterator.html" title="Random
Access Iterator">Random
Access Iterator</a>
</p>
</td>
<td>
<p>
Constant
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
<a href="random_access_iterator.html" title="Random
Access Iterator">Random
Access Iterator</a>
</p>
</td>
<td>
<p>
Constant
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
<a href="random_access_iterator.html" title="Random
Access Iterator">Random
Access Iterator</a>
</p>
</td>
<td>
<p>
Constant
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.iterator.concepts.random_access_iterator.meta_expressions"></a><h5>
<a name="id473053"></a>
<a href="random_access_iterator.html#fusion.iterator.concepts.random_access_iterator.meta_expressions">Meta
Expressions</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Expression
</p>
</th>
<th>
<p>
Compile Time Complexity
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<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>
<span class="identifier">N</span><span class="special">&gt;::</span><span class="identifier">type</span></tt>
</p>
</td>
<td>
<p>
Amortized constant time
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
<span class="identifier">M</span><span class="special">&gt;::</span><span class="identifier">type</span></tt>
</p>
</td>
<td>
<p>
Amortized constant time
</p>
</td>
</tr>
<tr>
<td>
<p>
<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><span class="identifier">J</span><span class="special">&gt;::</span><span class="identifier">type</span></tt>
</p>
</td>
<td>
<p>
Amortized constant time
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.iterator.concepts.random_access_iterator.models"></a><h5>
<a name="id473359"></a>
<a href="random_access_iterator.html#fusion.iterator.concepts.random_access_iterator.models">Models</a>
</h5>
<div class="itemizedlist"><ul type="disc">
<li>
<a href="../../container/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a>
iterator
</li>
<li>
<a href="../../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="../../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="../../view/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="../../sequence/concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a>)
</li>
<li>
<a href="../../view/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="../../sequence/concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a>)
</li>
<li>
<a href="../../view/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="../../sequence/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-2007 Joel de Guzman, Dan Marsden, Tobias
Schwinger</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="bidirectional_iterator.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.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="../functions.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>