Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/libs/mpl/doc/refmanual/random-access-iterator.html @ 45

Last change on this file since 45 was 29, checked in by landauf, 17 years ago

updated boost from 1_33_1 to 1_34_1
File size: 8.5 KB
Line 
1<?xml version="1.0" encoding="utf-8" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<!-- Copyright Aleksey Gurtovoy 2006. Distributed under the Boost -->
5<!-- Software License, Version 1.0. (See accompanying -->
6<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
7<head>
8<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9<meta name="generator" content="Docutils 0.3.6: http://docutils.sourceforge.net/" />
10<title>The MPL Reference Manual: Random Access Iterator</title>
11<link rel="stylesheet" href="../style.css" type="text/css" />
12</head>
13<body class="docframe refmanual">
14<table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./bidirectional-iterator.html" class="navigation-link">Prev</a>&nbsp;<a href="./iterator-metafunctions.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./bidirectional-iterator.html" class="navigation-link">Back</a>&nbsp;Along</span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./iterators-concepts.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
15<td class="header-group page-location"><a href="../refmanual.html" class="navigation-link">Front Page</a> / <a href="./iterators.html" class="navigation-link">Iterators</a> / <a href="./iterators-concepts.html" class="navigation-link">Concepts</a> / <a href="./random-access-iterator.html" class="navigation-link">Random Access Iterator</a></td>
16</tr></table><div class="header-separator"></div>
17<div class="section" id="random-access-iterator">
18<h1><a class="toc-backref" href="./iterators-concepts.html#id380" name="random-access-iterator">Random Access Iterator</a></h1>
19<div class="section" id="iterators-random-description">
20<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
21<p>A <a class="reference" href="./random-access-iterator.html">Random Access Iterator</a> is a <a class="reference" href="./bidirectional-iterator.html">Bidirectional Iterator</a> that provides
22constant-time guarantees on moving the iterator an arbitrary number of positions
23forward or backward and for measuring the distance to another iterator in the
24same sequence.</p>
25</div>
26<div class="section" id="iterators-random-refinement-of">
27<h3><a class="subsection-title" href="#refinement-of" name="refinement-of">Refinement of</a></h3>
28<p><a class="reference" href="./bidirectional-iterator.html">Bidirectional Iterator</a></p>
29</div>
30<div class="section" id="iterators-random-expression-requirements">
31<h3><a class="subsection-title" href="#expression-requirements" name="expression-requirements">Expression requirements</a></h3>
32<p>In addition to the requirements defined in <a class="reference" href="./bidirectional-iterator.html">Bidirectional Iterator</a>,
33the following requirements must be met.</p>
34<table border="1" class="table">
35<colgroup>
36<col width="28%" />
37<col width="44%" />
38<col width="28%" />
39</colgroup>
40<thead valign="bottom">
41<tr><th>Expression</th>
42<th>Type</th>
43<th>Complexity</th>
44</tr>
45</thead>
46<tbody valign="top">
47<tr><td><tt class="literal"><span class="pre"><a href="./next.html" class="identifier">next</a>&lt;i&gt;::type</span></tt></td>
48<td><a class="reference" href="./random-access-iterator.html">Random Access Iterator</a></td>
49<td>Amortized constant time</td>
50</tr>
51<tr><td><tt class="literal"><span class="pre"><a href="./prior.html" class="identifier">prior</a>&lt;i&gt;::type</span></tt></td>
52<td><a class="reference" href="./random-access-iterator.html">Random Access Iterator</a></td>
53<td>Amortized constant time</td>
54</tr>
55<tr><td><tt class="literal"><span class="pre">i::category</span></tt></td>
56<td><a class="reference" href="./integral-constant.html">Integral Constant</a>, convertible
57to <tt class="literal"><span class="pre">random_access_iterator_tag</span></tt></td>
58<td>Constant time</td>
59</tr>
60<tr><td><tt class="literal"><span class="pre"><a href="./advance.html" class="identifier">advance</a>&lt;i,n&gt;::type</span></tt></td>
61<td><a class="reference" href="./random-access-iterator.html">Random Access Iterator</a></td>
62<td>Amortized constant time</td>
63</tr>
64<tr><td><tt class="literal"><span class="pre"><a href="./distance.html" class="identifier">distance</a>&lt;i,j&gt;::type</span></tt></td>
65<td><a class="reference" href="./integral-constant.html">Integral Constant</a></td>
66<td>Amortized constant time</td>
67</tr>
68</tbody>
69</table>
70</div>
71<div class="section" id="iterators-random-expression-semantics">
72<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
73<pre class="literal-block">
74typedef <a href="./advance.html" class="identifier">advance</a>&lt;i,n&gt;::type j;
75</pre>
76<table class="field-list" frame="void" rules="none">
77<col class="field-name" />
78<col class="field-body" />
79<tbody valign="top">
80<tr class="field"><th class="field-name">Semantics:</th><td class="field-body">See <tt class="literal"><span class="pre"><a href="./advance.html" class="identifier">advance</a></span></tt> specification</td>
81</tr>
82</tbody>
83</table>
84<!-- .......................................................................... -->
85<pre class="literal-block">
86typedef <a href="./distance.html" class="identifier">distance</a>&lt;i,j&gt;::type n;
87</pre>
88<table class="field-list" frame="void" rules="none">
89<col class="field-name" />
90<col class="field-body" />
91<tbody valign="top">
92<tr class="field"><th class="field-name">Semantics:</th><td class="field-body">See <tt class="literal"><span class="pre"><a href="./distance.html" class="identifier">distance</a></span></tt> specification</td>
93</tr>
94</tbody>
95</table>
96</div>
97<div class="section" id="random-invariants">
98<h3><a class="subsection-title" href="#invariants" name="invariants">Invariants</a></h3>
99<p>For any random access iterators <tt class="literal"><span class="pre">i</span></tt> and <tt class="literal"><span class="pre">j</span></tt> the following invariants always
100hold:</p>
101<ul class="simple">
102<li>If <tt class="literal"><span class="pre"><a href="./advance.html" class="identifier">advance</a>&lt;i,n&gt;::type</span></tt> is well-defined, then
103<tt class="literal"><span class="pre"><a href="./advance.html" class="identifier">advance</a>&lt;</span> <span class="pre"><a href="./advance.html" class="identifier">advance</a>&lt;i,n&gt;::type,</span> <span class="pre"><a href="./negate.html" class="identifier">negate</a>&lt;n&gt;::type</span> <span class="pre">&gt;::type</span></tt> is a null operation.</li>
104</ul>
105</div>
106<div class="section" id="iterators-random-see-also">
107<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
108<p><a class="reference" href="./iterators.html">Iterators</a>, <a class="reference" href="./bidirectional-iterator.html">Bidirectional Iterator</a>, <a class="reference" href="./random-access-sequence.html">Random Access Sequence</a>, <a class="refentry reference" href="./advance.html"><tt class="refentry literal"><span class="pre">advance</span></tt></a>, <a class="refentry reference" href="./distance.html"><tt class="refentry literal"><span class="pre">distance</span></tt></a></p>
109<!-- modtime: November 15, 2004 02:45:20 +0000 -->
110</div>
111</div>
112
113<div class="footer-separator"></div>
114<table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./bidirectional-iterator.html" class="navigation-link">Prev</a>&nbsp;<a href="./iterator-metafunctions.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./bidirectional-iterator.html" class="navigation-link">Back</a>&nbsp;Along</span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./iterators-concepts.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
115</tr></table></body>
116</html>
Note: See TracBrowser for help on using the repository browser.