2004-06-29 02:58:13 +00:00
|
|
|
<HTML>
|
|
|
|
|
<!--
|
|
|
|
|
-- Copyright (c) Jeremy Siek 2000
|
|
|
|
|
--
|
|
|
|
|
-- Permission to use, copy, modify, distribute and sell this software
|
|
|
|
|
-- and its documentation for any purpose is hereby granted without fee,
|
|
|
|
|
-- provided that the above copyright notice appears in all copies and
|
|
|
|
|
-- that both that copyright notice and this permission notice appear
|
|
|
|
|
-- in supporting documentation. Silicon Graphics makes no
|
|
|
|
|
-- representations about the suitability of this software for any
|
|
|
|
|
-- purpose. It is provided "as is" without express or implied warranty.
|
|
|
|
|
-->
|
|
|
|
|
<Head>
|
2004-07-30 01:30:27 +00:00
|
|
|
<Title>Range Concepts</Title>
|
2004-06-29 02:58:13 +00:00
|
|
|
</HEAD>
|
|
|
|
|
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
|
|
|
|
|
ALINK="#ff0000">
|
|
|
|
|
<IMG SRC="cboost.gif"
|
|
|
|
|
ALT="C++ Boost">
|
|
|
|
|
<IMG SRC="/Images/stat.gif" ALT="" BORDER=0 WIDTH = "6" HEIGHT = "6" >
|
|
|
|
|
|
|
|
|
|
<BR Clear>
|
2004-07-30 01:30:27 +00:00
|
|
|
<H1>Range</H1>
|
2004-06-29 02:58:13 +00:00
|
|
|
|
|
|
|
|
<h3>Description</h3>
|
|
|
|
|
|
2004-07-30 01:30:27 +00:00
|
|
|
A Range is a <i>concept</i> similar to the STL <a
|
2004-06-29 02:58:13 +00:00
|
|
|
href="http://www.sgi.com/Technology/STL/Container.html">Container</a>
|
2004-07-30 01:30:27 +00:00
|
|
|
concept. A Range provides iterators for accessing a range of
|
2004-06-29 02:58:13 +00:00
|
|
|
elements and provides information about the number of elements in the
|
2004-07-30 01:30:27 +00:00
|
|
|
Range. However, a Range has fewer requirements than a
|
|
|
|
|
Container. The motivation for the Range concept is that there are
|
2004-06-29 02:58:13 +00:00
|
|
|
many useful Container-like types that do not meet the full
|
|
|
|
|
requirements of Container, and many algorithms that can be written
|
2004-07-30 01:30:27 +00:00
|
|
|
with this reduced set of requirements. In particular, a Range does
|
|
|
|
|
not necessarily
|
2004-06-29 02:58:13 +00:00
|
|
|
|
2004-07-30 01:30:27 +00:00
|
|
|
<ul>
|
|
|
|
|
<li> own the elements that can be accessed through it,
|
|
|
|
|
<li> have copy semantics,
|
|
|
|
|
<li> require that the associated reference type is a real C++ reference.
|
|
|
|
|
</ul>
|
2004-06-29 02:58:13 +00:00
|
|
|
|
2004-07-30 01:30:27 +00:00
|
|
|
Because of the second requirement, a Range object must
|
|
|
|
|
be passed by reference in generic code.
|
2004-06-29 02:58:13 +00:00
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
2004-07-30 01:30:27 +00:00
|
|
|
<h3>Notation</h3>
|
|
|
|
|
<Table>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>X</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
A type that is a model of Range.
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a</tt>, <tt>b</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Object of type <tt>X</tt>.
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>T</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
The value type of <tt>X</tt>.
|
|
|
|
|
</TD>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
2004-06-29 02:58:13 +00:00
|
|
|
<h3>Associated types</h3>
|
|
|
|
|
|
|
|
|
|
<Table border>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Value type
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>X::value_type</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
2004-07-30 01:30:27 +00:00
|
|
|
The type of the object stored in a Range.
|
|
|
|
|
<!--
|
2004-06-29 02:58:13 +00:00
|
|
|
If the Collection is <i>mutable</i> then
|
|
|
|
|
the value type must be <A
|
|
|
|
|
href="http://www.sgi.com/Technology/STL/Assignable.html">Assignable</A>.
|
|
|
|
|
Otherwise the value type must be <a href="./CopyConstructible.html">CopyConstructible</a>.
|
2004-07-30 01:30:27 +00:00
|
|
|
-->
|
2004-06-29 02:58:13 +00:00
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Iterator type
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>X::iterator</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
2004-07-30 01:30:27 +00:00
|
|
|
The type of iterator used to iterate through a Range's
|
2004-06-29 02:58:13 +00:00
|
|
|
elements. The iterator's value type is expected to be the
|
2004-07-30 01:30:27 +00:00
|
|
|
Range's value type. A conversion
|
2004-06-29 02:58:13 +00:00
|
|
|
from the iterator type to the const iterator type must exist.
|
2004-07-30 01:30:27 +00:00
|
|
|
The iterator type must at least be an <A
|
|
|
|
|
href="http://www.sgi.com/Technology/STL/InputIterator.html">InputIterator</A>.
|
2004-06-29 02:58:13 +00:00
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Const iterator type
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>X::const_iterator</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
A type of iterator that may be used to examine, but not to modify,
|
2004-07-30 01:30:27 +00:00
|
|
|
a Range's elements.
|
2004-06-29 02:58:13 +00:00
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Reference type
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>X::reference</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
2004-07-30 01:30:27 +00:00
|
|
|
A type that behaves like a reference to the Range's value type.
|
2004-06-29 02:58:13 +00:00
|
|
|
<a href="#1">[1]</a>
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
2004-07-30 01:30:27 +00:00
|
|
|
<!--
|
2004-06-29 02:58:13 +00:00
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Const reference type
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>X::const_reference</tt>
|
|
|
|
|
</TD>
|
2004-07-30 01:30:27 +00:00
|
|
|
|
|
|
|
|
<TD VAlign=top>
|
2004-06-29 02:58:13 +00:00
|
|
|
A type that behaves like a const reference to the Collection's value type.
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Pointer type
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>X::pointer</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
A type that behaves as a pointer to the Collection's value type.
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
2004-07-30 01:30:27 +00:00
|
|
|
-->
|
|
|
|
|
|
2004-06-29 02:58:13 +00:00
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Distance type
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>X::difference_type</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
A signed integral type used to represent the distance between two
|
2004-07-30 01:30:27 +00:00
|
|
|
of the Range's iterators. This type must be the same as
|
2004-06-29 02:58:13 +00:00
|
|
|
the iterator's distance type.
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Size type
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>X::size_type</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
An unsigned integral type that can represent any nonnegative value
|
2004-07-30 01:30:27 +00:00
|
|
|
of the Range's distance type.
|
2004-06-29 02:58:13 +00:00
|
|
|
</TD>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
2004-07-30 01:30:27 +00:00
|
|
|
|
2004-06-29 02:58:13 +00:00
|
|
|
<h3>Valid expressions</h3>
|
|
|
|
|
|
|
|
|
|
The following expressions must be valid.
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
<Table border>
|
|
|
|
|
<TR>
|
|
|
|
|
<TH>
|
|
|
|
|
Name
|
|
|
|
|
</TH>
|
|
|
|
|
<TH>
|
|
|
|
|
Expression
|
|
|
|
|
</TH>
|
|
|
|
|
<TH>
|
|
|
|
|
Return type
|
|
|
|
|
</TH>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Beginning of range
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.begin()</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>iterator</tt> if <tt>a</tt> is mutable, <tt>const_iterator</tt> otherwise
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
End of range
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.end()</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>iterator</tt> if <tt>a</tt> is mutable, <tt>const_iterator</tt> otherwise
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Size
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.size()</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>size_type</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<!--
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Maximum size
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.max_size()</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>size_type</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
-->
|
|
|
|
|
<TD VAlign=top>
|
2004-07-30 01:30:27 +00:00
|
|
|
Empty range
|
2004-06-29 02:58:13 +00:00
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.empty()</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Convertible to <tt>bool</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<!--
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Swap
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.swap(b)</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>void</tt>
|
|
|
|
|
</TD> -->
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
<h3>Expression semantics</h3>
|
|
|
|
|
|
|
|
|
|
<Table border>
|
|
|
|
|
<TR>
|
|
|
|
|
<TH>
|
|
|
|
|
Name
|
|
|
|
|
</TH>
|
|
|
|
|
<TH>
|
|
|
|
|
Expression
|
|
|
|
|
</TH>
|
|
|
|
|
<TH>
|
|
|
|
|
Semantics
|
|
|
|
|
</TH>
|
|
|
|
|
<TH>
|
|
|
|
|
Postcondition
|
|
|
|
|
</TH>
|
|
|
|
|
</TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Beginning of range
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.begin()</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
2004-07-30 01:30:27 +00:00
|
|
|
Returns an iterator pointing to the first element in the Range.
|
2004-06-29 02:58:13 +00:00
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.begin()</tt> is either dereferenceable or past-the-end. It is
|
|
|
|
|
past-the-end if and only if <tt>a.size() == 0</tt>.
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
End of range
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.end()</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Returns an iterator pointing one past the last element in the
|
2004-07-30 01:30:27 +00:00
|
|
|
Range.
|
2004-06-29 02:58:13 +00:00
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.end()</tt> is past-the-end.
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Size
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.size()</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Returns the size of the Collection, that is, its number of elements.
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.size() >= 0
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<!--
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Maximum size
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.max_size()</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Returns the largest size that this Collection can ever have. <A href="#8">[8]</A>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.max_size() >= 0 && a.max_size() >= a.size()</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
-->
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Empty Collection
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.empty()</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Equivalent to <tt>a.size() == 0</tt>. (But possibly faster.)
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<!--
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Swap
|
|
|
|
|
</TD>
|
|
|
|
|
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.swap(b)</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Equivalent to <tt>swap(a,b)</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
|
|
|
|
|
</TD>
|
|
|
|
|
-->
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
<h3>Complexity guarantees</h3>
|
|
|
|
|
|
2004-07-30 01:30:27 +00:00
|
|
|
All four functions are at most amortized linear time. For
|
|
|
|
|
most practical purposes, one can expect
|
|
|
|
|
<tt>begin()</tt>, <tt>end()</tt> and <tt>empty()</tt> to be amortized constant
|
|
|
|
|
time.
|
|
|
|
|
|
2004-06-29 02:58:13 +00:00
|
|
|
<h3>Invariants</h3>
|
|
|
|
|
<Table border>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Valid range
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
2004-07-30 01:30:27 +00:00
|
|
|
For any Range <tt>a</tt>, <tt>[a.begin(), a.end())</tt> is a valid
|
2004-06-29 02:58:13 +00:00
|
|
|
range.
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Range size
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.size()</tt> is equal to the distance from <tt>a.begin()</tt> to <tt>a.end()</tt>.
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Completeness
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
An algorithm that iterates through the range <tt>[a.begin(), a.end())</tt>
|
|
|
|
|
will pass through every element of <tt>a</tt>.
|
|
|
|
|
</TD>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Models</h3>
|
|
|
|
|
<UL>
|
2004-07-30 01:30:27 +00:00
|
|
|
<LI> <tt>boost::array<T,sz></tt>
|
|
|
|
|
<LI> <tt>std::vector<bool></tt>
|
2004-06-29 02:58:13 +00:00
|
|
|
</UL>
|
|
|
|
|
|
2004-07-30 01:30:27 +00:00
|
|
|
<h3>See also</h3>
|
|
|
|
|
<A href="http://www.sgi.com/Technology/STL/Container.html">Container</A>
|
2004-06-29 02:58:13 +00:00
|
|
|
|
2004-07-30 01:30:27 +00:00
|
|
|
<br><br>
|
|
|
|
|
<hr>
|
|
|
|
|
<br>
|
2004-06-29 02:58:13 +00:00
|
|
|
|
2004-07-30 01:30:27 +00:00
|
|
|
<h1>ReversibleRange</h1>
|
|
|
|
|
|
|
|
|
|
<h3>Description</h3>
|
|
|
|
|
This concept provides access to iterators that traverse in both
|
|
|
|
|
directions (forward and reverse). The iterator type must meet all of
|
|
|
|
|
the requirements of <a
|
|
|
|
|
href="http://www.sgi.com/Technology/STL/BidirectionalIterator.html">BidirectionalIterator</a>
|
|
|
|
|
except that the reference type does not have to be a real C++
|
|
|
|
|
reference.
|
|
|
|
|
|
|
|
|
|
<h3>Refinement of</h3>
|
|
|
|
|
Range
|
|
|
|
|
|
|
|
|
|
<h3>Associated types</h3>
|
|
|
|
|
|
|
|
|
|
<Table border>
|
2004-06-29 02:58:13 +00:00
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
2004-07-30 01:30:27 +00:00
|
|
|
Reverse Iterator type
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>X::reverse_iterator</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
The type of iterator used to iterate through a Range's
|
|
|
|
|
elements in reverse order. The iterator's value type is expected to be the
|
|
|
|
|
Range's value type. A conversion
|
|
|
|
|
from the reverse iterator type to the const reverse iterator type must exist.
|
|
|
|
|
The iterator type must at least be a <a
|
|
|
|
|
href="http://www.sgi.com/Technology/STL/BidirectionalIterator.html">BidirectionalIterator</a>.
|
2004-06-29 02:58:13 +00:00
|
|
|
</TD>
|
2004-07-30 01:30:27 +00:00
|
|
|
</TR>
|
|
|
|
|
<TR>
|
2004-06-29 02:58:13 +00:00
|
|
|
<TD VAlign=top>
|
2004-07-30 01:30:27 +00:00
|
|
|
Const reverse iterator type
|
2004-06-29 02:58:13 +00:00
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
2004-07-30 01:30:27 +00:00
|
|
|
<tt>X::const_reverse_iterator</tt>
|
2004-06-29 02:58:13 +00:00
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
2004-07-30 01:30:27 +00:00
|
|
|
A type of reverse iterator that may be used to examine, but not to modify,
|
|
|
|
|
a Range's elements.
|
2004-06-29 02:58:13 +00:00
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
2004-07-30 01:30:27 +00:00
|
|
|
<h3>Valid expressions</h3>
|
|
|
|
|
|
2004-06-29 02:58:13 +00:00
|
|
|
<Table border>
|
|
|
|
|
<TR>
|
|
|
|
|
<TH>
|
|
|
|
|
Name
|
|
|
|
|
</TH>
|
|
|
|
|
<TH>
|
|
|
|
|
Expression
|
|
|
|
|
</TH>
|
|
|
|
|
<TH>
|
|
|
|
|
Return type
|
|
|
|
|
</TH>
|
|
|
|
|
<TH>
|
|
|
|
|
Semantics
|
|
|
|
|
</TH>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Beginning of range
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.rbegin()</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>reverse_iterator</tt> if <tt>a</tt> is mutable,
|
|
|
|
|
<tt>const_reverse_iterator</tt> otherwise.
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Equivalent to <tt>X::reverse_iterator(a.end())</tt>.
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
End of range
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>a.rend()</tt>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
<tt>reverse_iterator</tt> if <tt>a</tt> is mutable,
|
|
|
|
|
<tt>const_reverse_iterator</tt> otherwise.
|
|
|
|
|
</TD>
|
|
|
|
|
<TD VAlign=top>
|
|
|
|
|
Equivalent to <tt>X::reverse_iterator(a.begin())</tt>.
|
|
|
|
|
</TD>
|
|
|
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
</table>
|
|
|
|
|
|
2004-07-30 01:30:27 +00:00
|
|
|
<h3>Complexity guarantees</h3>
|
|
|
|
|
|
|
|
|
|
<tt>rbegin()</tt> has the same complexity as <tt>end()</tt> and
|
|
|
|
|
<tt>rend()</tt> has the same complexity as <tt>begin()</tt> from Range.
|
2004-06-29 02:58:13 +00:00
|
|
|
|
2004-07-30 01:30:27 +00:00
|
|
|
<h3>Models</h3>
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
<li> std::vector<T>
|
|
|
|
|
<li> std::list<T>
|
|
|
|
|
</ul>
|
2004-06-29 02:58:13 +00:00
|
|
|
|
2004-07-30 01:30:27 +00:00
|
|
|
<hr>
|
2004-06-29 02:58:13 +00:00
|
|
|
<h3>Notes</h3>
|
|
|
|
|
|
|
|
|
|
<P><A name="1">[1]</A>
|
|
|
|
|
|
|
|
|
|
The reference type does not have to be a real C++ reference. The
|
|
|
|
|
requirements of the reference type depend on the context within which
|
2004-07-30 01:30:27 +00:00
|
|
|
the Range is being used. Specifically it depends on the
|
|
|
|
|
requirements the context places on the value type of the Range.
|
|
|
|
|
The reference type of the Range must meet the same requirements
|
2004-06-29 02:58:13 +00:00
|
|
|
as the value type. In addition, the reference objects must be
|
2004-07-30 01:30:27 +00:00
|
|
|
equivalent to the value type objects in the Range (which is
|
|
|
|
|
trivially true if they are the same). Also, in a mutable Range,
|
2004-06-29 02:58:13 +00:00
|
|
|
an assignment to the reference object must result in an assignment to
|
2004-07-30 01:30:27 +00:00
|
|
|
the object in the Range (again, which is trivially true if they
|
2004-06-29 02:58:13 +00:00
|
|
|
are the same object, but non-trivial if the reference type is a proxy
|
|
|
|
|
class).
|
|
|
|
|
|
|
|
|
|
|
2004-07-30 01:30:27 +00:00
|
|
|
<br><br>
|
2004-06-29 02:58:13 +00:00
|
|
|
<HR>
|
2004-07-30 01:30:27 +00:00
|
|
|
<br>
|
|
|
|
|
|
2004-06-29 02:58:13 +00:00
|
|
|
<TABLE>
|
|
|
|
|
<TR valign=top>
|
|
|
|
|
<TD nowrap>Copyright © 2000</TD><TD>
|
|
|
|
|
<A HREF=http://www.boost.org/people/jeremy_siek.htm>Jeremy Siek</A>, Univ.of Notre Dame and C++ Library & Compiler Group/SGI (<A HREF="mailto:jsiek@engr.sgi.com">jsiek@engr.sgi.com</A>)
|
|
|
|
|
</TD></TR>
|
|
|
|
|
<tr >
|
|
|
|
|
<TD nowrap>Copyright © 2004</TD><TD>
|
|
|
|
|
Thorsten Ottosen.
|
|
|
|
|
</TABLE>
|
|
|
|
|
|
|
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|
