2004-08-05 19:37:40 +00:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
|
|
|
|
|
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|
|
|
|
<title>Boost.Range Introduction </title>
|
|
|
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<table border="0" >
|
|
|
|
|
<tr>
|
2004-10-05 15:45:52 +00:00
|
|
|
<td ><img src="../../../boost.png" border="0" ></td>
|
2004-08-05 19:37:40 +00:00
|
|
|
<td ><h1 align="center">Boost.Range</h1></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<h2>Introduction</h2>
|
|
|
|
|
<p>
|
2005-08-12 13:02:37 +00:00
|
|
|
Generic algorithms have so far been specified in terms of two or more
|
|
|
|
|
iterators. Two iterators would together form a range of values that the
|
2004-08-24 15:58:01 +00:00
|
|
|
algorithm could work on. This leads to a very general interface, but also
|
|
|
|
|
to a somewhat clumsy use of the algorithms with redundant specification
|
|
|
|
|
of container names. Therefore we would like to raise the abstraction level
|
2005-08-12 13:02:37 +00:00
|
|
|
for algorithms so they specify their interface in terms of <a
|
2008-05-11 13:49:20 +00:00
|
|
|
href="range.html">Ranges</a> as much as possible.
|
2004-08-24 15:58:01 +00:00
|
|
|
</p>
|
2005-08-12 13:02:37 +00:00
|
|
|
|
2004-08-24 15:58:01 +00:00
|
|
|
<p>
|
2005-08-12 13:02:37 +00:00
|
|
|
The most common form of ranges we are used to work with is standard library
|
2004-08-24 15:58:01 +00:00
|
|
|
containers. However, one
|
2005-08-12 13:02:37 +00:00
|
|
|
often finds it desirable to extend that code to work with other types that
|
2004-08-24 15:58:01 +00:00
|
|
|
offer
|
2005-08-12 13:02:37 +00:00
|
|
|
enough functionality to satisfy the needs of the generic code
|
|
|
|
|
<i>if a suitable layer of indirection is applied </i>. For
|
2004-08-24 15:58:01 +00:00
|
|
|
example, raw arrays are often suitable for use with generic code that
|
2007-11-09 10:27:42 +00:00
|
|
|
works with containers, provided a suitable adapter is used.
|
2005-08-12 13:02:37 +00:00
|
|
|
</p>
|
|
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
<p>
|
2005-08-12 13:02:37 +00:00
|
|
|
This library therefore provides the means to adapt standard-like
|
2007-11-09 10:27:42 +00:00
|
|
|
containers, <code>std::pairs</code> of iterators, and raw arrays (and
|
|
|
|
|
more), such that
|
|
|
|
|
the same generic code can work with them all.
|
2005-08-12 13:02:37 +00:00
|
|
|
The basic idea is to add another layer of indirection using <a
|
|
|
|
|
href="../../mpl/doc/refmanual/metafunction.html">metafunctions</a> and
|
|
|
|
|
free-standing functions so syntactic and/or semantic differences can be removed.
|
2004-08-12 10:58:13 +00:00
|
|
|
</p>
|
2004-08-10 09:56:55 +00:00
|
|
|
|
2004-08-05 19:37:40 +00:00
|
|
|
<p >
|
|
|
|
|
The main advantages are
|
|
|
|
|
<ul >
|
|
|
|
|
<li >
|
2004-08-24 15:58:01 +00:00
|
|
|
simpler implementation and specification of generic range algorithms
|
2004-08-05 19:37:40 +00:00
|
|
|
</li>
|
|
|
|
|
<li >
|
2004-08-24 15:58:01 +00:00
|
|
|
more flexible, compact and maintainable client code
|
2004-08-05 19:37:40 +00:00
|
|
|
</li>
|
|
|
|
|
<li >
|
2007-10-27 15:58:22 +00:00
|
|
|
safe use of built-in arrays
|
2004-08-05 19:37:40 +00:00
|
|
|
</li>
|
2004-08-10 09:56:55 +00:00
|
|
|
|
2004-08-05 19:37:40 +00:00
|
|
|
</ul>
|
|
|
|
|
</p>
|
2008-01-12 12:38:57 +00:00
|
|
|
<p > Below is given a small example (the complete example can be found <a
|
2007-10-27 15:58:22 +00:00
|
|
|
href="../test/algorithm_example.cpp" target="_self" >here</a>): <blockquote>
|
2004-08-10 09:56:55 +00:00
|
|
|
<pre >
|
2004-08-12 10:58:13 +00:00
|
|
|
<span class=comment>
|
2004-08-10 09:56:55 +00:00
|
|
|
//
|
|
|
|
|
// example: extracting bounds in a generic algorithm
|
|
|
|
|
//
|
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>ForwardReadableRange</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>inline </span><span class=keyword>typename </span><span class=identifier>boost</span><span class=special>::</span><span class=identifier>range_iterator</span><span class=special>< </span><span class=identifier>ForwardReadableRange </span><span class=special>>::</span><span class=identifier>type
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=identifier>find</span><span class=special>( </span><span class=identifier>ForwardReadableRange</span><span class=special>& </span><span class=identifier>c</span><span class=special>, </span><span class=keyword>const </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>value </span><span class=special>)
|
|
|
|
|
</span><span class=special>{
|
|
|
|
|
</span><span class=keyword>return </span><span class=identifier>std</span><span class=special>::</span><span class=identifier>find</span><span class=special>( </span><span class=identifier>boost</span><span class=special>::</span><span class=identifier>begin</span><span class=special>( </span><span class=identifier>c </span><span class=special>), </span><span class=identifier>boost</span><span class=special>::</span><span class=identifier>end</span><span class=special>( </span><span class=identifier>c </span><span class=special>), </span><span class=identifier>value </span><span class=special>);
|
|
|
|
|
</span><span class=special>}
|
2005-12-09 22:22:32 +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>ForwardReadableRange</span><span class=special>, </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2007-10-27 15:58:22 +00:00
|
|
|
</span><span class=keyword>inline </span><span class=keyword>typename </span><span class=identifier>boost</span><span class=special>::</span><span class=identifier>range_iterator</span><span class=special>< </span><span class=keyword>const </span><span
|
2004-08-16 22:47:16 +00:00
|
|
|
class=identifier>ForwardReadableRange </span><span class=special>>::</span><span class=identifier>type
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=identifier>find</span><span class=special>( </span><span class=keyword>const </span><span class=identifier>ForwardReadableRange</span><span class=special>& </span><span class=identifier>c</span><span class=special>, </span><span class=keyword>const </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>value </span><span class=special>)
|
|
|
|
|
</span><span class=special>{
|
|
|
|
|
</span><span class=keyword>return </span><span class=identifier>std</span><span class=special>::</span><span class=identifier>find</span><span class=special>( </span><span class=identifier>boost</span><span class=special>::</span><span class=identifier>begin</span><span class=special>( </span><span class=identifier>c </span><span class=special>), </span><span class=identifier>boost</span><span class=special>::</span><span class=identifier>end</span><span class=special>( </span><span class=identifier>c </span><span class=special>), </span><span class=identifier>value </span><span class=special>);
|
|
|
|
|
</span><span class=special>}
|
2005-12-09 22:22:32 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=comment>//
|
2004-08-10 09:56:55 +00:00
|
|
|
// replace first value and return its index
|
|
|
|
|
//
|
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>ForwardReadableWriteableRange</span><span class=special>, </span><span class=keyword>class </span><span class=identifier>T </span><span class=special>>
|
2007-10-27 15:58:22 +00:00
|
|
|
</span><span class=keyword>inline </span><span class=keyword>typename </span><span class=identifier>boost</span><span class=special>::</span><span class=identifier>range_difference</span><span class=special>< </span><span class=identifier>ForwardReadableWriteableRange </span><span class=special>>::</span><span class=identifier>type
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=identifier>my_generic_replace</span><span class=special>( </span><span class=identifier>ForwardReadableWriteableRange</span><span class=special>& </span><span class=identifier>c</span><span class=special>, </span><span class=keyword>const </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>value</span><span class=special>, </span><span class=keyword>const </span><span class=identifier>T</span><span class=special>& </span><span class=identifier>replacement </span><span class=special>)
|
|
|
|
|
</span><span class=special>{
|
2004-08-16 22:47:16 +00:00
|
|
|
</span><span class=keyword>typename </span><span class=identifier>boost</span><span class=special>::</span><span class=identifier>range_iterator</span><span class=special>< </span><span class=identifier>ForwardReadableWriteableRange </span><span class=special>>::</span><span class=identifier>type </span><span class=identifier>found </span><span class=special>= </span><span class=identifier>find</span><span class=special>( </span><span class=identifier>c</span><span class=special>, </span><span class=identifier>value </span><span class=special>);
|
2005-12-09 22:22:32 +00:00
|
|
|
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>if</span><span class=special>( </span><span class=identifier>found </span><span class=special>!= </span><span class=identifier>boost</span><span class=special>::</span><span class=identifier>end</span><span class=special>( </span><span class=identifier>c </span><span class=special>) </span><span class=special>)
|
|
|
|
|
</span><span class=special>*</span><span class=identifier>found </span><span class=special>= </span><span class=identifier>replacement</span><span class=special>;
|
|
|
|
|
</span><span class=keyword>return </span><span class=identifier>std</span><span class=special>::</span><span class=identifier>distance</span><span class=special>( </span><span class=identifier>boost</span><span class=special>::</span><span class=identifier>begin</span><span class=special>( </span><span class=identifier>c </span><span class=special>), </span><span class=identifier>found </span><span class=special>);
|
|
|
|
|
</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 09:56:55 +00:00
|
|
|
// usage
|
|
|
|
|
//
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>const </span><span class=keyword>int </span><span class=identifier>N </span><span class=special>= </span><span class=number>5</span><span class=special>;
|
|
|
|
|
</span><span class=identifier>std</span><span class=special>::</span><span class=identifier>vector</span><span class=special><</span><span class=keyword>int</span><span class=special>> </span><span class=identifier>my_vector</span><span class=special>;
|
2005-12-09 22:22:32 +00:00
|
|
|
</span><span class=keyword>int </span><span class=identifier>values</span><span class=special>[] </span><span class=special>= </span><span class=special>{ </span><span class=number>1</span><span class=special>,</span><span class=number>2</span><span class=special>,</span><span class=number>3</span><span class=special>,</span><span class=number>4</span><span class=special>,</span><span class=number>5</span><span class=special>,</span><span class=number>6</span><span class=special>,</span><span class=number>7</span><span class=special>,</span><span class=number>8</span><span class=special>,</span><span class=number>9 </span><span class=special>};
|
2004-08-12 10:58:13 +00:00
|
|
|
</span>
|
2005-12-09 22:22:32 +00:00
|
|
|
<span class=identifier>my_vector</span><span class=special>.</span><span
|
2004-08-12 10:58:13 +00:00
|
|
|
class=identifier>assign</span><span class=special>( </span><span class=identifier>values</span><span class=special>, </span><span class=identifier>boost</span><span class=special>::</span><span class=identifier>end</span><span class=special>( </span><span class=identifier>values </span><span class=special>) </span><span class=special>);</span>
|
2008-06-24 15:39:28 +00:00
|
|
|
<span class=keyword>typedef </span><span class=identifier>std</span><span class=special>::</span><span class=identifier>vector</span><span class=special><</span><span class=keyword>int</span><span class=special>>::</span><span class=identifier>iterator </span><span class=identifier>iterator</span><span class=special>;
|
2004-08-24 15:58:01 +00:00
|
|
|
</span><span class=identifier>std</span><span class=special>::</span><span class=identifier>pair</span><span class=special><</span><span class=identifier>iterator</span><span class=special>,</span><span class=identifier>iterator</span><span class=special>> </span><span class=identifier>my_view</span><span class=special>( </span><span class=identifier>boost</span><span class=special>::</span><span class=identifier>begin</span><span class=special>( </span><span class=identifier>my_vector </span><span class=special>),
|
|
|
|
|
</span><span class=identifier>boost</span><span class=special>::</span><span class=identifier>begin</span><span class=special>( </span><span class=identifier>my_vector </span><span class=special>) </span><span class=special>+ </span><span class=identifier>N </span><span class=special>);
|
2004-08-12 10:58:13 +00:00
|
|
|
</span><span class=keyword>char </span><span class=identifier>str_val</span><span class=special>[] </span><span class=special>= </span><span class=string>"a string"</span><span class=special>;
|
|
|
|
|
</span><span class=keyword>char</span><span class=special>* </span><span class=identifier>str </span><span class=special>= </span><span class=identifier>str_val</span><span class=special>;
|
2005-12-09 22:22:32 +00:00
|
|
|
|
|
|
|
|
</span><span class=identifier>std</span><span class=special>::</span><span class=identifier>cout </span><span class=special><< </span><span class=identifier>my_generic_replace</span><span class=special>( </span><span class=identifier>my_vector</span><span class=special>, </span><span class=number>4</span><span class=special>, </span><span class=number>2 </span><span class=special>);
|
|
|
|
|
</span><span class=identifier>std</span><span class=special>::</span><span class=identifier>cout </span><span class=special><< </span><span class=identifier>my_generic_replace</span><span class=special>( </span><span class=identifier>my_view</span><span class=special>, </span><span class=number>4</span><span class=special>, </span><span class=number>2 </span><span class=special>);
|
|
|
|
|
</span><span class=identifier>std</span><span class=special>::</span><span class=identifier>cout </span><span class=special><< </span><span class=identifier>my_generic_replace</span><span class=special>( </span><span class=identifier>str</span><span class=special>, </span><span class=literal>'a'</span><span class=special>, </span><span class=literal>'b' </span><span class=special>);
|
2004-08-12 10:58:13 +00:00
|
|
|
</span>
|
|
|
|
|
<span class=comment>// prints '3', '5' and '0' </span>
|
2004-08-10 09:56:55 +00:00
|
|
|
</pre>
|
|
|
|
|
</blockquote>
|
|
|
|
|
|
2005-12-09 22:22:32 +00:00
|
|
|
By using the free-standing functions and <a
|
|
|
|
|
href="../../mpl/doc/refmanual/metafunction.html">metafunctions</a>, the code automatically
|
|
|
|
|
works for all the types supported by this library; now and in the future.
|
2004-08-12 10:58:13 +00:00
|
|
|
Notice that we have to
|
2005-12-09 22:22:32 +00:00
|
|
|
provide two version of <code >find()</code> since we cannot forward a non-const
|
|
|
|
|
rvalue with reference arguments (see this article about <a href="http://std.dkuug.dk/jtc1/sc22/wg21/docs/papers/2002/n1385.htm" target="_self" >The
|
2004-08-05 19:37:40 +00:00
|
|
|
Forwarding Problem</a> ).
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
<p>
|
2008-02-06 23:12:21 +00:00
|
|
|
© <a name="Copyright" id="Copyright">Copyright</a> Thorsten Ottosen 2008.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
Distributed under the Boost Software License, Version 1.0. (See
|
|
|
|
|
accompanying file LICENSE_1_0.txt or copy
|
|
|
|
|
at <a href=
|
|
|
|
|
"http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)
|
2004-08-05 19:37:40 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
|
