Files
boost_fusion/doc/html/fusion/sequences/concepts/bidirectional_sequence.html
Joel de Guzman c31253d8c1 adding fusion docs and tests
[SVN r34920]
2006-08-22 15:57:13 +00:00

237 lines
11 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

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

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Bidirectional
Sequence</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 1. Fusion 2.0">
<link rel="up" href="../concepts.html" title="Concepts">
<link rel="prev" href="forward_sequence.html" title="Forward
Sequence">
<link rel="next" href="random_access_sequence.html" title="Random
Access Sequence">
</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_sequence.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_sequence.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.sequences.concepts.bidirectional_sequence"></a><a href="bidirectional_sequence.html" title="Bidirectional
Sequence">Bidirectional
Sequence</a></h4></div></div></div>
<a name="fusion.sequences.concepts.bidirectional_sequence.description"></a><h5>
<a name="id473452"></a>
<a href="bidirectional_sequence.html#fusion.sequences.concepts.bidirectional_sequence.description">Description</a>
</h5>
<p>
A Bidirectional Sequence is a <a href="forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a> whose iterators model <a href="../../iterators/concepts/bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a>.
</p>
<a name="fusion.sequences.concepts.bidirectional_sequence.refinement_of"></a><h5>
<a name="id473502"></a>
<a href="bidirectional_sequence.html#fusion.sequences.concepts.bidirectional_sequence.refinement_of">Refinement
of</a>
</h5>
<p>
<a href="forward_sequence.html" title="Forward
Sequence">Forward Sequence</a>
</p>
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">s</span></tt></span></dt>
<dd>
A Forward Sequence
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">S</span></tt></span></dt>
<dd>
A Forward Sequence type
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">o</span></tt></span></dt>
<dd>
An arbitrary object
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">e</span></tt></span></dt>
<dd>
A Sequence element
</dd>
</dl>
</div>
<a name="fusion.sequences.concepts.bidirectional_sequence.valid_expressions"></a><h5>
<a name="id473622"></a>
<a href="bidirectional_sequence.html#fusion.sequences.concepts.bidirectional_sequence.valid_expressions">Valid
Expressions</a>
</h5>
<p>
In addition to the requirements defined in <a href="forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>, for any Bidirectional Sequence the following must be met:
</p>
<div class="informaltable">
<h4>
<a name="id473658"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Expression</th>
<th>Return type</th>
<th>Type Requirements</th>
<th>Runtime
Complexity</th>
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td><a href="../../iterators/concepts/bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a></td>
<td> </td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/end.html" title="end"><tt class="computeroutput"><span class="identifier">end</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td><a href="../../iterators/concepts/bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a></td>
<td> </td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/back.html" title="back"><tt class="computeroutput"><span class="identifier">back</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td>Any
type</td>
<td> </td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/back.html" title="back"><tt class="computeroutput"><span class="identifier">back</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span> <span class="special">=</span> <span class="identifier">o</span></tt></td>
<td>Any
type</td>
<td>
<tt class="computeroutput"><span class="identifier">s</span></tt>
is mutable and <tt class="computeroutput"><span class="identifier">e</span> <span class="special">=</span> <span class="identifier">o</span></tt>,
where <tt class="computeroutput"><span class="identifier">e</span></tt> is the first
element in the sequence, is a valid expression.</td>
<td>Constant</td>
</tr>
</tbody>
</table>
</div>
<a name="fusion.sequences.concepts.bidirectional_sequence.result_type_expressions"></a><h5>
<a name="id473964"></a>
<a href="bidirectional_sequence.html#fusion.sequences.concepts.bidirectional_sequence.result_type_expressions">Result
Type Expressions</a>
</h5>
<div class="informaltable">
<h4>
<a name="id473988"></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="../intrinsics/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">S</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="../intrinsics/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">S</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="../intrinsics/metafunctions/back.html" title="back"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">back</span></tt></a><span class="special">&lt;</span><span class="identifier">S</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.sequences.concepts.bidirectional_sequence.expression_semantics"></a><h5>
<a name="id474206"></a>
<a href="bidirectional_sequence.html#fusion.sequences.concepts.bidirectional_sequence.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_sequence.html" title="Forward
Sequence">Forward
Sequence</a>.
</p>
<div class="informaltable">
<h4>
<a name="id474245"></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="../intrinsics/functions/back.html" title="back"><tt class="computeroutput"><span class="identifier">back</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td>The
last element in the sequence; see <a href="../intrinsics/functions/back.html" title="back"><tt class="computeroutput"><span class="identifier">back</span></tt></a>.</td>
</tr></tbody>
</table>
</div>
<a name="fusion.sequences.concepts.bidirectional_sequence.models"></a><h5>
<a name="id474342"></a>
<a href="bidirectional_sequence.html#fusion.sequences.concepts.bidirectional_sequence.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></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></li>
<li><a href="../containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a></li>
<li>
<a href="../views/iterator_range.html" title="iterator_range"><tt class="computeroutput"><span class="identifier">iterator_range</span></tt></a>
(where adapted sequence is a Bidirectional Sequence)
</li>
<li>
<a href="../views/transform_view.html" title="transform_view"><tt class="computeroutput"><span class="identifier">transform_view</span></tt></a>
(where adapted sequence is a Bidirectional Sequence)
</li>
<li><a href="../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 © 2001-2005 Joel de Guzman, Dan Marsden</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="forward_sequence.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_sequence.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>