2004-11-28 03:35:12 +00:00
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" />
2010-08-09 20:07:24 +00:00
< meta name = "generator" content = "Docutils 0.7: http://docutils.sourceforge.net/" />
2004-11-28 03:35:12 +00:00
< title > The MPL Reference Manual: Random Access Iterator</ title >
< link rel = "stylesheet" href = "../style.css" type = "text/css" />
</ head >
< body class = "docframe refmanual" >
< 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 > < a href = "./iterator-metafunctions.html" class = "navigation-link" > Next</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./bidirectional-iterator.html" class = "navigation-link" > Back</ a > Along</ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./iterators-concepts.html" class = "navigation-link" > Up</ a > < a href = "../refmanual.html" class = "navigation-link" > Home</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./refmanual_toc.html" class = "navigation-link" > Full TOC</ a ></ span ></ td >
< 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 >
</ tr ></ table >< div class = "header-separator" ></ div >
< div class = "section" id = "random-access-iterator" >
2010-08-09 20:07:24 +00:00
< h1 >< a class = "toc-backref" href = "./iterators-concepts.html#id1452" > Random Access Iterator</ a ></ h1 >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id397" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#description" name = "description" > Description</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< p > A < a class = "reference internal" href = "./random-access-iterator.html" > Random Access Iterator</ a > is a < a class = "reference internal" href = "./bidirectional-iterator.html" > Bidirectional Iterator</ a > that provides
2004-11-28 03:35:12 +00:00
constant-time guarantees on moving the iterator an arbitrary number of positions
2009-08-17 11:30:52 +00:00
forward or backward and for measuring the distance to another iterator in the
2004-11-28 03:35:12 +00:00
same sequence.</ p >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id398" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#refinement-of" name = "refinement-of" > Refinement of</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< p >< a class = "reference internal" href = "./bidirectional-iterator.html" > Bidirectional Iterator</ a ></ p >
2004-11-28 03:35:12 +00:00
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id399" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#expression-requirements" name = "expression-requirements" > Expression requirements</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< p > In addition to the requirements defined in < a class = "reference internal" href = "./bidirectional-iterator.html" > Bidirectional Iterator</ a > ,
2004-11-28 03:35:12 +00:00
the following requirements must be met.</ p >
2009-08-17 11:30:52 +00:00
< table border = "1" class = "docutils table" >
2004-11-28 03:35:12 +00:00
< colgroup >
< col width = "28%" />
< col width = "44%" />
< col width = "28%" />
</ colgroup >
< thead valign = "bottom" >
2009-08-17 11:30:52 +00:00
< tr >< th class = "head" > Expression</ th >
< th class = "head" > Type</ th >
< th class = "head" > Complexity</ th >
2004-11-28 03:35:12 +00:00
</ tr >
</ thead >
< tbody valign = "top" >
< tr >< td >< tt class = "literal" >< span class = "pre" >< a href = "./next.html" class = "identifier" > next</ a > < i> ::type</ span ></ tt ></ td >
2009-08-17 11:30:52 +00:00
< td >< a class = "reference internal" href = "./random-access-iterator.html" > Random Access Iterator</ a ></ td >
2004-11-28 03:35:12 +00:00
< td > Amortized constant time</ td >
</ tr >
< tr >< td >< tt class = "literal" >< span class = "pre" >< a href = "./prior.html" class = "identifier" > prior</ a > < i> ::type</ span ></ tt ></ td >
2009-08-17 11:30:52 +00:00
< td >< a class = "reference internal" href = "./random-access-iterator.html" > Random Access Iterator</ a ></ td >
2004-11-28 03:35:12 +00:00
< td > Amortized constant time</ td >
</ tr >
< tr >< td >< tt class = "literal" >< span class = "pre" > i::category</ span ></ tt ></ td >
2009-08-17 11:30:52 +00:00
< td >< a class = "reference internal" href = "./integral-constant.html" > Integral Constant</ a > , convertible
2004-11-28 03:35:12 +00:00
to < tt class = "literal" >< span class = "pre" > random_access_iterator_tag</ span ></ tt ></ td >
< td > Constant time</ td >
</ tr >
< tr >< td >< tt class = "literal" >< span class = "pre" >< a href = "./advance.html" class = "identifier" > advance</ a > < i,n> ::type</ span ></ tt ></ td >
2009-08-17 11:30:52 +00:00
< td >< a class = "reference internal" href = "./random-access-iterator.html" > Random Access Iterator</ a ></ td >
2004-11-28 03:35:12 +00:00
< td > Amortized constant time</ td >
</ tr >
< tr >< td >< tt class = "literal" >< span class = "pre" >< a href = "./distance.html" class = "identifier" > distance</ a > < i,j> ::type</ span ></ tt ></ td >
2009-08-17 11:30:52 +00:00
< td >< a class = "reference internal" href = "./integral-constant.html" > Integral Constant</ a ></ td >
2004-11-28 03:35:12 +00:00
< td > Amortized constant time</ td >
</ tr >
</ tbody >
</ table >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id400" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#expression-semantics" name = "expression-semantics" > Expression semantics</ a ></ h3 >
< pre class = "literal-block" >
typedef < a href = "./advance.html" class = "identifier" > advance</ a > < i,n> ::type j;
</ pre >
2009-08-17 11:30:52 +00:00
< table class = "docutils field-list" frame = "void" rules = "none" >
2004-11-28 03:35:12 +00:00
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
< 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 >
</ tr >
</ tbody >
</ table >
<!-- .......................................................................... -->
< pre class = "literal-block" >
typedef < a href = "./distance.html" class = "identifier" > distance</ a > < i,j> ::type n;
</ pre >
2009-08-17 11:30:52 +00:00
< table class = "docutils field-list" frame = "void" rules = "none" >
2004-11-28 03:35:12 +00:00
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
< 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 >
</ tr >
</ tbody >
</ table >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id401" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#invariants" name = "invariants" > Invariants</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< 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
2004-11-28 03:35:12 +00:00
hold:</ p >
< ul class = "simple" >
2009-08-17 11:30:52 +00:00
< li > If < tt class = "literal" >< span class = "pre" >< a href = "./advance.html" class = "identifier" > advance</ a > < i,n> ::type</ span ></ tt > is well-defined, then
2004-11-28 03:35:12 +00:00
< tt class = "literal" >< span class = "pre" >< a href = "./advance.html" class = "identifier" > advance</ a > < </ span > < span class = "pre" >< a href = "./advance.html" class = "identifier" > advance</ a > < i,n> ::type,</ span > < span class = "pre" >< a href = "./negate.html" class = "identifier" > negate</ a > < n> ::type</ span > < span class = "pre" > > ::type</ span ></ tt > is a null operation.</ li >
</ ul >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id402" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#see-also" name = "see-also" > See also</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< p >< a class = "reference internal" href = "./iterators.html" > Iterators</ a > , < a class = "reference internal" href = "./bidirectional-iterator.html" > Bidirectional Iterator</ a > , < a class = "reference internal" href = "./random-access-sequence.html" > Random Access Sequence</ a > , < a class = "reference internal" href = "./advance.html" > advance</ a > , < a class = "reference internal" href = "./distance.html" > distance</ a ></ p >
2004-11-28 03:35:12 +00:00
</ div >
</ div >
< div class = "footer-separator" ></ div >
< 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 > < a href = "./iterator-metafunctions.html" class = "navigation-link" > Next</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./bidirectional-iterator.html" class = "navigation-link" > Back</ a > Along</ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./iterators-concepts.html" class = "navigation-link" > Up</ a > < a href = "../refmanual.html" class = "navigation-link" > Home</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./refmanual_toc.html" class = "navigation-link" > Full TOC</ a ></ span ></ td >
2009-08-17 11:30:52 +00:00
< td >< div class = "copyright-footer" >< div class = "copyright" > Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</ div >
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at < a class = "reference external" href = "http://www.boost.org/LICENSE_1_0.txt" target = "_top" > http://www.boost.org/LICENSE_1_0.txt</ a > )</ div ></ td ></ tr ></ table ></ body >
2004-11-28 03:35:12 +00:00
</ html >
