Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/libs/mpl/doc/refmanual/advance.html @ 13

Last change on this file since 13 was 12, checked in by landauf, 18 years ago

added boost
File size: 9.2 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<head>
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<meta name="generator" content="Docutils 0.3.6: http://docutils.sourceforge.net/" />
7<title>The MPL Reference Manual: advance</title>
8<link rel="stylesheet" href="../style.css" type="text/css" />
9</head>
10<body class="docframe refmanual">
11<table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./iterator-metafunctions.html" class="navigation-link">Prev</a>&nbsp;<a href="./distance.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group">Back&nbsp;<a href="./distance.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./iterator-metafunctions.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>
12<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="./iterator-metafunctions.html" class="navigation-link">Iterator Metafunctions</a> / <a href="./advance.html" class="navigation-link">advance</a></td>
13</tr></table><div class="header-separator"></div>
14<div class="section" id="advance">
15<h1><a class="toc-backref" href="./iterator-metafunctions.html#id382" name="advance">advance</a></h1>
16<div class="section" id="advance-synopsis">
17<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
18<pre class="literal-block">
19template&lt;
20      typename Iterator
21    , typename N
22    &gt;
23struct <a href="./advance.html" class="identifier">advance</a>
24{
25    typedef <em>unspecified</em> type;
26};
27</pre>
28</div>
29<div class="section" id="advance-description">
30<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
31<p>Moves <tt class="literal"><span class="pre">Iterator</span></tt> by the distance <tt class="literal"><span class="pre">N</span></tt>. For <a class="reference" href="./bidirectional-iterator.html">bidirectional</a> and
32<a class="reference" href="./random-access-iterator.html">random access</a> iterators, the distance may be negative.</p>
33</div>
34<div class="section" id="advance-header">
35<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
36<pre class="literal-block">
37#include &lt;<a href="../../../../boost/mpl/advance.hpp" class="header">boost/mpl/advance.hpp</a>&gt;
38</pre>
39</div>
40<div class="section" id="advance-parameters">
41<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
42<table border="1" class="table">
43<colgroup>
44<col width="19%" />
45<col width="35%" />
46<col width="45%" />
47</colgroup>
48<thead valign="bottom">
49<tr><th>Parameter</th>
50<th>Requirement</th>
51<th>Description</th>
52</tr>
53</thead>
54<tbody valign="top">
55<tr><td><tt class="literal"><span class="pre">Iterator</span></tt></td>
56<td><a class="reference" href="./forward-iterator.html">Forward Iterator</a></td>
57<td>An iterator to advance.</td>
58</tr>
59<tr><td><tt class="literal"><span class="pre">N</span></tt></td>
60<td><a class="reference" href="./integral-constant.html">Integral Constant</a></td>
61<td>A distance.</td>
62</tr>
63</tbody>
64</table>
65</div>
66<div class="section" id="advance-model-of">
67<h3><a class="subsection-title" href="#model-of" name="model-of">Model Of</a></h3>
68<p><a class="reference" href="./tag-dispatched.html">Tag Dispatched Metafunction</a></p>
69</div>
70<div class="section" id="advance-expression-semantics">
71<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
72<p>For a <a class="reference" href="./forward-iterator.html">Forward Iterator</a> <tt class="literal"><span class="pre">iter</span></tt> and arbitrary <a class="reference" href="./integral-constant.html">Integral Constant</a> <tt class="literal"><span class="pre">n</span></tt>:</p>
73<pre class="literal-block">
74typedef <a href="./advance.html" class="identifier">advance</a>&lt;iter,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">Return type:</th><td class="field-body"><a class="reference" href="./forward-iterator.html">Forward Iterator</a>.</td>
81</tr>
82<tr class="field"><th class="field-name">Precondition:</th><td class="field-body">If <tt class="literal"><span class="pre">Iterator</span></tt> is a <a class="reference" href="./forward-iterator.html">Forward Iterator</a>, <tt class="literal"><span class="pre">n::value</span></tt> must be nonnegative.</td>
83</tr>
84<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to:</p>
85<pre class="literal-block">
86typedef iter i0;
87typedef <a href="./next.html" class="identifier">next</a>&lt;i0&gt;::type i1;
88<em>...</em>
89typedef <a href="./next.html" class="identifier">next</a>&lt;i<em>n-1</em>&gt;::type j;
90</pre>
91<p>if <tt class="literal"><span class="pre">n::value</span> <span class="pre">&gt;</span> <span class="pre">0</span></tt>, and</p>
92<pre class="literal-block">
93typedef iter i0;
94typedef <a href="./prior.html" class="identifier">prior</a>&lt;i0&gt;::type i1;
95<em>...</em>
96typedef <a href="./prior.html" class="identifier">prior</a>&lt;i<em>n-1</em>&gt;::type j;
97</pre>
98<p class="last">otherwise.</p>
99</td>
100</tr>
101<tr class="field"><th class="field-name">Postcondition:</th><td class="field-body"><tt class="literal"><span class="pre">j</span></tt> is dereferenceable or past-the-end;
102<tt class="literal"><span class="pre"><a href="./distance.html" class="identifier">distance</a>&lt;iter,j&gt;::value</span> <span class="pre">==</span> <span class="pre">n::value</span></tt> if <tt class="literal"><span class="pre">n::value</span> <span class="pre">&gt;</span> <span class="pre">0</span></tt>, and
103<tt class="literal"><span class="pre"><a href="./distance.html" class="identifier">distance</a>&lt;j,iter&gt;::value</span> <span class="pre">==</span> <span class="pre">n::value</span></tt> otherwise.</td>
104</tr>
105</tbody>
106</table>
107</div>
108<div class="section" id="advance-complexity">
109<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
110<p>Amortized constant time if <tt class="literal"><span class="pre">iter</span></tt> is a model of
111<a class="reference" href="./random-access-iterator.html">Random Access Iterator</a>, otherwise linear time.</p>
112</div>
113<div class="section" id="advance-example">
114<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
115<pre class="literal-block">
116typedef <a href="./range-c.html" class="identifier">range_c</a>&lt;int,0,10&gt; numbers;
117typedef <a href="./begin.html" class="identifier">begin</a>&lt;numbers&gt;::type first;
118typedef <a href="./end.html" class="identifier">end</a>&lt;numbers&gt;::type last;
119
120typedef <a href="./advance.html" class="identifier">advance</a>&lt;first,<a href="./int.html" class="identifier">int_</a>&lt;10&gt; &gt;::type i1;
121typedef <a href="./advance.html" class="identifier">advance</a>&lt;last,<a href="./int.html" class="identifier">int_</a>&lt;-10&gt; &gt;::type i2;
122
123<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( boost::is_same&lt;i1,last&gt; ));
124<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( boost::is_same&lt;i2,first&gt; ));
125</pre>
126</div>
127<div class="section" id="advance-see-also">
128<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
129<p><a class="reference" href="./iterators.html">Iterators</a>, <a class="reference" href="./tag-dispatched.html">Tag Dispatched Metafunction</a>, <a class="refentry reference" href="./distance.html"><tt class="refentry literal"><span class="pre">distance</span></tt></a>, <a class="refentry reference" href="./next.html"><tt class="refentry literal"><span class="pre">next</span></tt></a></p>
130<!-- modtime: November 11, 2004 11:16:39 +0000 -->
131<!-- Iterators/Iterator Metafunctions//distance |20 -->
132</div>
133</div>
134
135<div class="footer-separator"></div>
136<table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./iterator-metafunctions.html" class="navigation-link">Prev</a>&nbsp;<a href="./distance.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group">Back&nbsp;<a href="./distance.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./iterator-metafunctions.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>
137</tr></table></body>
138</html>
Note: See TracBrowser for help on using the repository browser.