2004-08-05 19:37:40 +00:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<title>Boost.Range Range Implementation </title>
|
|
|
|
|
<meta http-equiv="Content-Type"content="text/html; charset=iso-8859-1">
|
2004-08-10 09:56:55 +00:00
|
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
2004-08-05 19:37:40 +00:00
|
|
|
</head>
|
|
|
|
|
|
2004-08-10 11:53:33 +00:00
|
|
|
<body>
|
2004-08-05 19:37:40 +00:00
|
|
|
|
2004-08-10 11:53:33 +00:00
|
|
|
<table >
|
|
|
|
|
<tr >
|
2004-10-05 15:45:52 +00:00
|
|
|
<td ><img src="../../../boost.png" width="100%" border="0"></td>
|
2004-08-10 11:53:33 +00:00
|
|
|
<td ><h1 ><br>
|
|
|
|
|
Boost.Range </h1></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
2004-08-05 19:37:40 +00:00
|
|
|
|
2004-08-10 11:53:33 +00:00
|
|
|
<h2>Single Pass Range, Forward Range and Bidirectional Range Implementation</h2>
|
2004-08-05 19:37:40 +00:00
|
|
|
|
2004-08-10 11:53:33 +00:00
|
|
|
<ul >
|
|
|
|
|
<li>
|
|
|
|
|
<a href="#overview">Overview</a>
|
|
|
|
|
<li >
|
|
|
|
|
<a href="#Synopsis" >Synopsis</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li >
|
|
|
|
|
<a href="#Semantics" >Semantics</a>
|
|
|
|
|
</li>
|
2004-08-12 10:58:13 +00:00
|
|
|
<li>
|
|
|
|
|
<a href="#minimal_interface">Extending the library</a>
|
2004-08-10 11:53:33 +00:00
|
|
|
</ul>
|
|
|
|
|
<hr size="1" >
|
2004-08-10 09:56:55 +00:00
|
|
|
|
2004-08-26 23:35:36 +00:00
|
|
|
<a name="overview"></a>
|
2004-08-10 11:53:33 +00:00
|
|
|
<h3>Overview</h3>
|
|
|
|
|
<p>
|
|
|
|
|
Four types of objects are currently supported by the library:
|
|
|
|
|
<ul >
|
|
|
|
|
<li >
|
2004-08-12 10:58:13 +00:00
|
|
|
standard-like containers
|
2004-08-10 11:53:33 +00:00
|
|
|
</li>
|
|
|
|
|
<li >
|
|
|
|
|
<code >std::pair<iterator,iterator></code>
|
|
|
|
|
</li>
|
|
|
|
|
<li >
|
|
|
|
|
null terminated strings (this includes <code >char[]</code>,<code >wchar_t[]</code>,
|
|
|
|
|
<code >char*</code>, and <code >wchar_t*</code>)
|
|
|
|
|
</li>
|
|
|
|
|
<li >
|
|
|
|
|
built-in arrays
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
2004-08-12 10:58:13 +00:00
|
|
|
|
|
|
|
|
Even though the behavior of the primary templates are exactly such that standard
|
|
|
|
|
containers will be supported by default, the requirements are much lower than
|
|
|
|
|
the standard container requirements. For example, the utility class <a
|
|
|
|
|
href="utility_class.html#iter_range"><code>iterator_range</code></a> implements
|
|
|
|
|
the <a href="#minimal_interface">minimal interface</a> required to make the
|
2004-08-16 22:47:16 +00:00
|
|
|
class a <a href="range.html#forward_range">Forward Range</a>.
|
2004-08-10 11:53:33 +00:00
|
|
|
</p>
|
2004-08-12 10:58:13 +00:00
|
|
|
|
2004-08-10 11:53:33 +00:00
|
|
|
<p>
|
2004-09-16 18:56:31 +00:00
|
|
|
Please also see <a href="range.html">Range concepts</a> for more details.
|
2004-08-10 11:53:33 +00:00
|
|
|
</p>
|
2004-08-12 10:58:13 +00:00
|
|
|
|
|
|
|
|
<a name="Synopsis" ></a> <h3 >Synopsis</h3>
|
2004-08-10 09:56:55 +00:00
|
|
|
|
2004-08-10 11:53:33 +00:00
|
|
|
<p >
|
2004-08-10 09:56:55 +00:00
|
|
|
|
2004-08-10 11:53:33 +00:00
|
|
|
<pre>
|
2004-08-12 10:58:13 +00:00
|
|
|
<span class=keyword>namespace </span><span class=identifier>boost</span>
|
|
|
|
|
<span class=special>{
|
|
|
|
|
</span><span class=comment>//
|
2004-08-10 11:53:33 +00:00
|
|
|
// Single Pass Range metafunctions
|
2004-08-10 09:56:55 +00:00
|
|
|
//
|
|
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2004-08-16 22:47:16 +00:00
|
|
|
</span><span class=keyword>struct </span><a href="#range_value"><span
|
|
|
|
|
class=identifier>range_value</span></a><span class=special>;
|
2004-08-10 09:56:55 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2004-08-16 22:47:16 +00:00
|
|
|
</span><span class=keyword>struct </span><a href="#range_iterator"><span
|
|
|
|
|
class=identifier>range_iterator</span></a><span class=special>;
|
2004-08-10 09:56:55 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2004-08-16 22:47:16 +00:00
|
|
|
</span><span class=keyword>struct </span><a href="#range_const_iterator"><span
|
|
|
|
|
class=identifier>range_const_iterator</span></a><span class=special>;
|
2004-08-10 11:53:33 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=comment>//
|
2004-08-10 11:53:33 +00:00
|
|
|
// Forward Range metafunctions
|
|
|
|
|
//
|
|
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2004-08-16 22:47:16 +00:00
|
|
|
</span><span class=keyword>struct </span><a href="#range_difference"><span
|
|
|
|
|
class=identifier>range_difference</span></a><span class=special>;
|
2004-08-10 09:56:55 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2004-08-16 22:47:16 +00:00
|
|
|
</span><span class=keyword>struct </span><a href="#range_size"><span
|
|
|
|
|
class=identifier>range_size</span></a><span class=special>;
|
2004-08-10 11:53:33 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=comment>//
|
2004-08-10 11:53:33 +00:00
|
|
|
// Bidirectional Range metafunctions
|
|
|
|
|
//
|
2004-08-10 09:56:55 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
|
|
|
|
</span><span class=keyword>struct </span><a
|
2004-08-16 22:47:16 +00:00
|
|
|
href="#range_reverse_iterator"><span
|
|
|
|
|
class=identifier>range_reverse_iterator</span></a><span class=special>;
|
2004-08-10 11:53:33 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
|
|
|
|
</span><span class=keyword>struct </span><a
|
2004-08-16 22:47:16 +00:00
|
|
|
href="#range_const_reverse_iterator"><span
|
|
|
|
|
class=identifier>range_const_reverse_iterator</span></a><span class=special>;
|
2004-08-10 11:53:33 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=comment>//
|
2004-08-10 11:53:33 +00:00
|
|
|
// Special metafunctions
|
|
|
|
|
//
|
2004-06-29 02:58:13 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2004-08-16 22:47:16 +00:00
|
|
|
</span><span class=keyword>struct </span><a href="#range_result_iterator"><span
|
|
|
|
|
class=identifier>range_result_iterator</span></a><span class=special>;
|
2004-08-10 09:56:55 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
|
|
|
|
</span><span class=keyword>struct </span><a
|
2004-08-16 22:47:16 +00:00
|
|
|
href="#range_reverse_result_iterator"><span
|
|
|
|
|
class=identifier>range_reverse_result_iterator</span></a><span class=special>;
|
2004-08-10 11:53:33 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=comment>//
|
2004-08-10 11:53:33 +00:00
|
|
|
// Single Pass Range functions
|
2004-08-10 09:56:55 +00:00
|
|
|
//
|
|
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2004-08-16 22:47:16 +00:00
|
|
|
</span><span class=keyword></span><span class=keyword>typename </span><span class=identifier>range_iterator</span><span class=special><</span><span class=identifier>T</span><span class=special>>::</span><span class=identifier>type
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><a href="#begin"><span class=identifier>begin</span></a><span class=special>( </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>c </span><span class=special>);
|
2004-08-10 09:56:55 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2004-08-16 22:47:16 +00:00
|
|
|
</span><span class=keyword></span><span class=keyword>typename </span><span class=identifier>range_const_iterator</span><span class=special><</span><span class=identifier>T</span><span class=special>>::</span><span class=identifier>type
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><a href="#begin"><span class=identifier>begin</span></a><span class=special>( </span><span class=keyword>const </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>c </span><span class=special>);
|
2004-06-29 02:58:13 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2004-08-16 22:47:16 +00:00
|
|
|
</span><span class=keyword></span><span class=keyword>typename </span><span class=identifier>range_iterator</span><span class=special><</span><span class=identifier>T</span><span class=special>>::</span><span class=identifier>type
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><a href="#end"><span class=identifier>end</span></a><span class=special>( </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>c </span><span class=special>);
|
2004-08-10 09:56:55 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2004-08-16 22:47:16 +00:00
|
|
|
</span><span class=keyword></span><span class=keyword>typename </span><span class=identifier>range_const_iterator</span><span class=special><</span><span class=identifier>T</span><span class=special>>::</span><span class=identifier>type
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><a href="#end"><span class=identifier>end</span></a><span class=special>( </span><span class=keyword>const </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>c </span><span class=special>);
|
2004-08-10 09:56:55 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
|
|
|
|
</span><span class=keyword></span><span class=keyword>bool
|
|
|
|
|
</span><a href="#empty"><span class=identifier>empty</span></a><span class=special>( </span><span class=keyword>const </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>c </span><span class=special>);
|
2004-08-10 09:56:55 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=comment>//
|
2004-08-10 11:53:33 +00:00
|
|
|
// Forward Range functions
|
|
|
|
|
//
|
|
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2004-08-16 22:47:16 +00:00
|
|
|
</span><span class=keyword></span><span class=keyword>typename </span><span class=identifier>range_size</span><span class=special><</span><span class=identifier>T</span><span class=special>>::</span><span class=identifier>type
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><a href="#size"><span class=identifier>size</span></a><span class=special>( </span><span class=keyword>const </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>c </span><span class=special>);
|
2004-08-10 11:53:33 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=comment>//
|
2004-08-10 11:53:33 +00:00
|
|
|
// Bidirectional Range functions
|
|
|
|
|
//
|
|
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2004-08-16 22:47:16 +00:00
|
|
|
</span><span class=keyword></span><span class=keyword>typename </span><span class=identifier>range_reverse_iterator</span><span class=special><</span><span class=identifier>T</span><span class=special>>::</span><span class=identifier>type
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><a href="#rbegin"><span class=identifier>rbegin</span></a><span class=special>( </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>c </span><span class=special>);
|
2004-08-10 11:53:33 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2004-08-16 22:47:16 +00:00
|
|
|
</span><span class=keyword></span><span class=keyword>typename </span><span class=identifier>range_const_reverse_iterator</span><span class=special><</span><span class=identifier>T</span><span class=special>>::</span><span class=identifier>type
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><a href="#rbegin"><span class=identifier>rbegin</span></a><span class=special>( </span><span class=keyword>const </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>c </span><span class=special>);
|
2004-08-10 11:53:33 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2004-08-16 22:47:16 +00:00
|
|
|
</span><span class=keyword></span><span class=keyword>typename </span><span class=identifier>range_reverse_iterator</span><span class=special><</span><span class=identifier>T</span><span class=special>>::</span><span class=identifier>type
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><a href="#rend"><span class=identifier>rend</span></a><span class=special>( </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>c </span><span class=special>);
|
2004-08-10 11:53:33 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2004-08-16 22:47:16 +00:00
|
|
|
</span><span class=keyword></span><span class=keyword>typename </span><span class=identifier>range_const_reverse_iterator</span><span class=special><</span><span class=identifier>T</span><span class=special>>::</span><span class=identifier>type
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><a href="#rend"><span class=identifier>rend</span></a><span class=special>( </span><span class=keyword>const </span><span
|
|
|
|
|
class=identifier>T</span><span class=special>& </span><span class=identifier>c </span><span class=special>);
|
|
|
|
|
</span>
|
2004-09-16 18:56:31 +00:00
|
|
|
<span class=comment>//
|
|
|
|
|
// Special const Range functions
|
|
|
|
|
//
|
|
|
|
|
</span>
|
|
|
|
|
<span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>></span>
|
|
|
|
|
<span class=keyword>typename </span><span class=identifier>range_const_iterator</span><span class=special><</span><span class=identifier>T</span><span class=special>>::</span><span class=identifier>type </span>
|
|
|
|
|
<a href="#const_begin"><span class=identifier>const_begin</span></a><span class=special>(</span><span class=keyword> const </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>r </span><span class=special>);
|
|
|
|
|
</span>
|
|
|
|
|
<span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>></span>
|
|
|
|
|
<span class=keyword>typename </span><span class=identifier>range_const_iterator</span><span class=special><</span><span class=identifier>T</span><span class=special>>::</span><span class=identifier>type </span>
|
|
|
|
|
<a href="#const_end"><span class=identifier>const_end</span></a><span class=special>(</span><span class=keyword> const </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>r </span><span class=special>);
|
|
|
|
|
</span>
|
|
|
|
|
<span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>></span>
|
|
|
|
|
<span class=keyword>typename </span><span class=identifier>range_const_reverse_iterator</span><span class=special><</span><span class=identifier>T</span><span class=special>>::</span><span class=identifier>type </span>
|
|
|
|
|
<a href="#const_rbegin"><span class=identifier>const_rbegin</span></a><span class=special>(</span><span class=keyword> const </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>r </span><span class=special>);
|
|
|
|
|
</span>
|
|
|
|
|
<span class=keyword>template</span><span class=special>< </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>></span>
|
|
|
|
|
<span class=keyword>typename </span><span class=identifier>range_const_reverse_iterator</span><span class=special><</span><span class=identifier>T</span><span class=special>>::</span><span class=identifier>type </span>
|
|
|
|
|
<a href="#const_rend"><span class=identifier>const_rend</span></a><span class=special>( </span><span class=keyword>const </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>r </span><span class=special>);</span>
|
|
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
<span class=special>} </span><span class=comment>// namespace 'boost'
|
2004-09-16 18:56:31 +00:00
|
|
|
</span>
|
|
|
|
|
</pre>
|
2004-08-10 11:53:33 +00:00
|
|
|
</p>
|
|
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
<a name="Semantics" ></a> <h3 >Semantics</h3>
|
2004-08-05 19:37:40 +00:00
|
|
|
|
2004-08-10 11:53:33 +00:00
|
|
|
<h4>notation</h4>
|
|
|
|
|
<p>
|
|
|
|
|
<table cellpadding="5" border="1">
|
|
|
|
|
<tr>
|
|
|
|
|
<th>Type
|
|
|
|
|
<th>Object
|
|
|
|
|
<th>Describes
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>X</code>
|
2004-08-12 10:58:13 +00:00
|
|
|
<td><code>x</code>
|
2004-08-10 11:53:33 +00:00
|
|
|
<td>any type
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>T</code> </td>
|
|
|
|
|
<td><code>t</code>
|
|
|
|
|
<td>denotes behavior of the primary templates</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>P</code>
|
|
|
|
|
<td><code>p</code>
|
|
|
|
|
<td>denotes <code>std::pair<iterator,iterator></code>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>A[sz]</code>
|
|
|
|
|
<td><code>a</code>
|
|
|
|
|
<td>denotes an array of type <code>A</code> of size <code>sz</code>
|
|
|
|
|
<tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>Char*</code>
|
|
|
|
|
<td><code>s</code>
|
|
|
|
|
<td>denotes either <code>char*</code> or <code>wchar_t*</code>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</p>
|
2004-08-05 19:37:40 +00:00
|
|
|
|
2004-08-10 11:53:33 +00:00
|
|
|
<p>
|
2004-08-12 10:58:13 +00:00
|
|
|
Please notice in tables below that when four lines appear in a cell, the first
|
|
|
|
|
line will describe the primary template, the second line pairs of iterators, the
|
|
|
|
|
third line arrays and the last line null-terminated strings.
|
2004-08-10 11:53:33 +00:00
|
|
|
</p>
|
|
|
|
|
<h4>Metafunctions</h4>
|
|
|
|
|
<p>
|
|
|
|
|
<table border="1" cellpadding="5" >
|
|
|
|
|
<tr >
|
|
|
|
|
<th >Expression</th>
|
|
|
|
|
<th >Return type</th>
|
|
|
|
|
<th >Complexity</th>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr >
|
2004-08-16 22:47:16 +00:00
|
|
|
<a name="range_value" ></a>
|
|
|
|
|
<td ><code >range_value<X>::type</code></td>
|
2004-08-10 11:53:33 +00:00
|
|
|
<td ><code >T::value_type</code><br>
|
|
|
|
|
<code >boost::iterator_value<P::first_type>::type</code><br>
|
|
|
|
|
<code >A</code><br>
|
|
|
|
|
<code>Char</code>
|
|
|
|
|
<td >compile time</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr >
|
2004-08-16 22:47:16 +00:00
|
|
|
<a name="range_iterator" ></a>
|
|
|
|
|
<td ><code >range_iterator<X>::type</code></td>
|
2004-08-10 11:53:33 +00:00
|
|
|
<td ><code >T::iterator</code><br>
|
2004-08-12 10:58:13 +00:00
|
|
|
<code >P::first_type</code><br>
|
|
|
|
|
<code >A*</code><br>
|
|
|
|
|
<code>Char*</code>
|
2004-08-10 11:53:33 +00:00
|
|
|
<td >compile time</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr >
|
2004-08-16 22:47:16 +00:00
|
|
|
<a name="range_const_iterator" ></a>
|
|
|
|
|
<td ><code >range_const_iterator<X>::type</code></td>
|
2004-08-10 11:53:33 +00:00
|
|
|
<td ><code >T::const_iterator</code><br>
|
2004-08-12 10:58:13 +00:00
|
|
|
<code >P::first_type</code><br>
|
2004-08-10 11:53:33 +00:00
|
|
|
<code >const A*</code><br>
|
|
|
|
|
<code>const Char*</code>
|
|
|
|
|
<td >compile time</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr >
|
2004-08-16 22:47:16 +00:00
|
|
|
<a name="range_difference" ></a>
|
|
|
|
|
<td ><code >range_difference<X>::type</code></td>
|
2004-08-10 11:53:33 +00:00
|
|
|
<td ><code >T::difference_type</code><br>
|
2004-08-12 10:58:13 +00:00
|
|
|
<code
|
2004-08-10 11:53:33 +00:00
|
|
|
>boost_iterator_difference<P::first_type>::type</code><br>
|
2004-08-12 10:58:13 +00:00
|
|
|
<code >std::ptrdiff_t</code><br>
|
|
|
|
|
<code >std::ptrdiff_t</code><br>
|
2004-08-10 11:53:33 +00:00
|
|
|
<td >compile time</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr >
|
2004-08-16 22:47:16 +00:00
|
|
|
<a name="range_size" ></a>
|
|
|
|
|
<td ><code >range_size<X>::type</code></td>
|
2004-08-10 11:53:33 +00:00
|
|
|
<td ><code >T::size_type</code><br>
|
|
|
|
|
<code >std::size_t</code><br>
|
|
|
|
|
<code >std::size_t</code><br>
|
|
|
|
|
<code >std::size_t</code><br>
|
|
|
|
|
<td >compile time</td>
|
|
|
|
|
</tr>
|
2004-08-05 19:37:40 +00:00
|
|
|
<tr >
|
2004-08-16 22:47:16 +00:00
|
|
|
<a name="range_result_iterator" ></a>
|
|
|
|
|
<td ><code >range_result_iterator<X>::type</code></td>
|
|
|
|
|
<td ><code >range_const_iterator<X>::type</code> if <code
|
2004-08-12 10:58:13 +00:00
|
|
|
>X</code> is <code >const</code> <br>
|
2004-08-16 22:47:16 +00:00
|
|
|
<code >range_iterator<X>::type</code> otherwise </td>
|
2004-08-10 11:53:33 +00:00
|
|
|
<td >compile time</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr >
|
2004-08-16 22:47:16 +00:00
|
|
|
<a name="range_reverse_iterator" ></a>
|
|
|
|
|
<td ><code >range_reverse_iterator<X>::type</code></td>
|
|
|
|
|
<td ><code >boost::reverse_iterator< typename range_iterator<T>::type ></code><br>
|
2004-08-10 11:53:33 +00:00
|
|
|
<td >compile time</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr >
|
2004-08-16 22:47:16 +00:00
|
|
|
<a name="range_const_reverse_iterator" ></a>
|
|
|
|
|
<td ><code >range_const_reverse_iterator<X>::type</code></td>
|
|
|
|
|
<td ><code >boost::reverse_iterator< typename range_const_iterator<T>::type ></code>
|
2004-08-10 11:53:33 +00:00
|
|
|
<br>
|
|
|
|
|
<td >compile time</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr >
|
2004-08-16 22:47:16 +00:00
|
|
|
<a name="range_reverse_result_iterator" ></a>
|
|
|
|
|
<td ><code >range_reverse_result_iterator<X>::type</code></td>
|
|
|
|
|
<td ><code >boost::reverse_iterator< typename range_result_iterator<T>::type
|
2004-08-12 10:58:13 +00:00
|
|
|
></code>
|
2004-08-10 11:53:33 +00:00
|
|
|
<td >compile time</td>
|
|
|
|
|
</tr>
|
2004-08-05 19:37:40 +00:00
|
|
|
|
|
|
|
|
|
2004-08-10 11:53:33 +00:00
|
|
|
</table>
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
2004-08-16 22:47:16 +00:00
|
|
|
The special metafunctions <code>range_result_iterator</code> and <code>range_reverse_result_iterator</code>
|
2004-08-12 10:58:13 +00:00
|
|
|
are not part of any Range concept, but they are very useful when implementing
|
|
|
|
|
certain Range classes like <a
|
|
|
|
|
href="utility_class.html#sub_range"><code>sub_range</code></a> because of their
|
|
|
|
|
ability to select iterators based on constness.
|
2004-08-10 11:53:33 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<h4>Functions</h4>
|
|
|
|
|
<p>
|
|
|
|
|
<table border="1" cellpadding="5" >
|
|
|
|
|
<tr >
|
|
|
|
|
<th >Expression</th>
|
|
|
|
|
<th >Return type</th>
|
|
|
|
|
<th >Returns</th>
|
|
|
|
|
<th >Complexity</th>
|
|
|
|
|
</tr>
|
2004-08-05 19:37:40 +00:00
|
|
|
<tr >
|
2004-08-10 11:53:33 +00:00
|
|
|
<a name="begin" ></a>
|
|
|
|
|
<td ><code >begin(x)</code></td>
|
2004-08-16 22:47:16 +00:00
|
|
|
<td ><code >range_result_iterator<X>::type</code></td>
|
2004-08-10 11:53:33 +00:00
|
|
|
<td ><code >t.begin()</code><br>
|
2004-08-12 10:58:13 +00:00
|
|
|
<code >p.first</code><br>
|
2004-08-10 11:53:33 +00:00
|
|
|
<code >a</code><br>
|
|
|
|
|
<code>s</code>
|
|
|
|
|
<td >constant time</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr >
|
|
|
|
|
<a name="end" ></a>
|
|
|
|
|
<td ><code >end(x)</code></td>
|
2004-08-16 22:47:16 +00:00
|
|
|
<td ><code >range_result_iterator<X>::type</code></td>
|
2004-08-10 11:53:33 +00:00
|
|
|
<td ><code >t.end()</code><br>
|
2004-08-12 10:58:13 +00:00
|
|
|
<code >p.second</code><br>
|
|
|
|
|
<code >a + sz</code> <br>
|
|
|
|
|
<code >s + std::char_traits<X>::length( s )</code> if <code >X</code> is <code >Char*</code>
|
|
|
|
|
<br>
|
2004-08-10 11:53:33 +00:00
|
|
|
<code >s + sz - 1</code> if <code >X</code> is <code >Char[sz]</code> <br>
|
2004-08-05 19:37:40 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
|
2004-08-10 11:53:33 +00:00
|
|
|
<td >linear if <code >X</code> is <code >Char*</code> <br>
|
|
|
|
|
constant time otherwise</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr >
|
|
|
|
|
<a name="empty" ></a>
|
|
|
|
|
<td ><code >empty(x)</code></td>
|
|
|
|
|
<td ><code >bool</code></td>
|
|
|
|
|
<td ><code >begin(x) == end( x )</code><br>
|
|
|
|
|
<td >linear if <code >X</code> is <code >Char*</code> <br>
|
|
|
|
|
constant time otherwise<br>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr >
|
|
|
|
|
<a name="size" ></a>
|
|
|
|
|
<td ><code >size(x)</code></td>
|
2004-08-16 22:47:16 +00:00
|
|
|
<td ><code >range_size<X>::type</code></td>
|
2004-08-10 11:53:33 +00:00
|
|
|
<td ><code >t.size()</code><br>
|
2004-08-12 10:58:13 +00:00
|
|
|
<code>std::distance(p.first,p.second)</code><br>
|
|
|
|
|
<code >sz</code><br>
|
|
|
|
|
<code>end(s) - s</code>
|
2004-08-05 19:37:40 +00:00
|
|
|
|
2004-08-10 11:53:33 +00:00
|
|
|
<td >linear if <code >X</code> is <code >Char*</code> <br>
|
|
|
|
|
or if <code >std::distance()</code> is linear <br>
|
|
|
|
|
constant time otherwise</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr >
|
|
|
|
|
<a name="rbegin" ></a>
|
|
|
|
|
<td ><code >rbegin(x)</code></td>
|
2004-08-16 22:47:16 +00:00
|
|
|
<td ><code >range_reverse_result_iterator<X>::type</code></td>
|
|
|
|
|
<td ><code >range_reverse_result_iterator<X>::type( end(x) )</code> <br>
|
2004-08-12 10:58:13 +00:00
|
|
|
<td >same as <code>end(x)</code> </td>
|
2004-08-10 11:53:33 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr >
|
|
|
|
|
<a name="rend" ></a>
|
|
|
|
|
<td ><code >rend(x)</code></td>
|
2004-08-16 22:47:16 +00:00
|
|
|
<td ><code >range_reverse_result_iterator<X>::type</code></td>
|
|
|
|
|
<td ><code >range_reverse_result_iterator<X>::type( begin(x) )</code>
|
2004-08-12 10:58:13 +00:00
|
|
|
<td >same as <code>begin(x)</code></td>
|
2004-08-10 11:53:33 +00:00
|
|
|
</tr>
|
2004-09-16 18:56:31 +00:00
|
|
|
<tr >
|
|
|
|
|
<a name="const_begin" ></a>
|
|
|
|
|
<td ><code >const_begin(x)</code></td>
|
|
|
|
|
<td ><code >range_const_iterator<X>::type</code></td>
|
|
|
|
|
<td ><code >range_const_iterator<X>::type( begin(x) )</code>
|
|
|
|
|
<br> <td >same as <code>begin(x)</code> </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr >
|
|
|
|
|
<a name="const_end" ></a>
|
|
|
|
|
<td ><code >const_end(x)</code></td>
|
|
|
|
|
<td ><code >range_const_iterator<X>::type</code></td>
|
|
|
|
|
<td ><code >range_const_iterator<X>::type( end(x) )</code>
|
|
|
|
|
<td >same as <code>end(x)</code></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr >
|
|
|
|
|
<a name="const_rbegin" ></a>
|
|
|
|
|
<td ><code >const_rbegin(x)</code></td>
|
|
|
|
|
<td ><code >range_const_reverse_iterator<X>::type</code></td>
|
|
|
|
|
<td ><code >range_const_reverse_iterator<X>::type( rbegin(x) )</code>
|
|
|
|
|
<br> <td >same as <code>rbegin(x)</code> </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr >
|
|
|
|
|
<a name="const_rend" ></a>
|
|
|
|
|
<td ><code >const_rend(x)</code></td>
|
|
|
|
|
<td ><code >range_const_reverse_iterator<X>::type</code></td>
|
|
|
|
|
<td ><code >range_const_reverse_iterator<X>::type( rend(x) )</code>
|
|
|
|
|
<td >same as <code>rend(x)</code></td>
|
|
|
|
|
</tr>
|
2004-08-05 19:37:40 +00:00
|
|
|
|
2004-08-10 11:53:33 +00:00
|
|
|
</table>
|
|
|
|
|
</p>
|
2004-09-16 18:56:31 +00:00
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
The special <code>const</code> functions are not part of any Range concept,
|
|
|
|
|
but are very useful when you want to document clearly that your code is
|
|
|
|
|
read-only.
|
|
|
|
|
</p>
|
2004-08-05 19:37:40 +00:00
|
|
|
|
|
|
|
|
<hr>
|
2004-08-12 10:58:13 +00:00
|
|
|
<a name=minimal_interface></a> <h3>Extending the library</h3>
|
|
|
|
|
<p>
|
|
|
|
|
The primary templates in this library are implemented such that standard
|
|
|
|
|
containers will work automatically and so will <code>boost::<a
|
|
|
|
|
href=../../array/index.html>array</a></code>. Below is given an overview of
|
|
|
|
|
which member functions and member types a class must specify to
|
|
|
|
|
be useable as a certain Range concept.
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
<table cellpadding="5" border="1">
|
|
|
|
|
<tr>
|
|
|
|
|
<th>Member function</th>
|
|
|
|
|
<th>Related concept</th>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>begin()</code></td>
|
2004-08-16 22:47:16 +00:00
|
|
|
<td><a href="range.html#single_pass_range">Single Pass Range</a></td>
|
2004-08-12 10:58:13 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>end()</code> </td>
|
2004-08-16 22:47:16 +00:00
|
|
|
<td><a href="range.html#single_pass_range">Single Pass Range</a></td>
|
2004-08-12 10:58:13 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>size()</code></td>
|
2004-08-16 22:47:16 +00:00
|
|
|
<td><a href="range.html#forward_range">Forward Range</a></td>
|
2004-08-12 10:58:13 +00:00
|
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
</table>
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
Notice that <code>rbegin()</code> and <code>rend()</code> member functions
|
|
|
|
|
are not needed even though the container can support bidirectional iteration.
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
The required member types are:
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
<table cellpadding="5" border="1">
|
|
|
|
|
<tr>
|
|
|
|
|
<th>Member type</th>
|
|
|
|
|
<th>Related concept</th>
|
|
|
|
|
<tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>value_type</code></td>
|
2004-08-16 22:47:16 +00:00
|
|
|
<td><a href="range.html#single_pass_range">Single Pass Range</a></td>
|
2004-08-12 10:58:13 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>iterator</code></td>
|
2004-08-16 22:47:16 +00:00
|
|
|
<td><a href="range.html#single_pass_range">Single Pass Range</a></td>
|
2004-08-12 10:58:13 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>const_iterator</code></td>
|
2004-08-16 22:47:16 +00:00
|
|
|
<td><a href="range.html#single_pass_range">Single Pass Range</a></td>
|
2004-08-12 10:58:13 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>difference_type</code></td>
|
2004-08-16 22:47:16 +00:00
|
|
|
<td><a href="range.html#forward_range">Forward Range</a></td>
|
2004-08-12 10:58:13 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>size_type</code></td>
|
2004-08-16 22:47:16 +00:00
|
|
|
<td><a href="range.html#forward_range">Forward Range</a></td>
|
2004-08-12 10:58:13 +00:00
|
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
</table>
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
Again one should notice that member types <code>reverse_iterator</code> and
|
|
|
|
|
<code>const_reverse_iterator</code> are not needed.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<hr>
|
2004-08-05 19:37:40 +00:00
|
|
|
<p>
|
|
|
|
|
(C) Copyright Thorsten Ottosen 2003-2004
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
