2003-08-05 19:48:41 +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" />
2004-01-13 15:59:47 +00:00
< meta name = "generator" content = "Docutils 0.3.1: http://docutils.sourceforge.net/" />
2003-08-05 19:48:41 +00:00
< title > Transform Iterator</ title >
< meta name = "author" content = "David Abrahams, Jeremy Siek, Thomas Witt" />
< meta name = "organization" content = "Boost Consulting, Indiana University Open Systems Lab, University of Hanover Institute for Transport Railway Operation and Construction" />
2004-01-13 02:58:21 +00:00
< meta name = "date" content = "2004-01-13" />
2004-01-12 01:30:47 +00:00
< meta name = "copyright" content = "Copyright David Abrahams, Jeremy Siek, and Thomas Witt 2003. All rights reserved" />
2003-08-05 19:48:41 +00:00
< link rel = "stylesheet" href = "default.css" type = "text/css" />
</ head >
< body >
< div class = "document" id = "transform-iterator" >
< h1 class = "title" > Transform Iterator</ h1 >
< table class = "docinfo" frame = "void" rules = "none" >
< col class = "docinfo-name" />
< col class = "docinfo-content" />
< tbody valign = "top" >
< tr >< th class = "docinfo-name" > Author:</ th >
< td > David Abrahams, Jeremy Siek, Thomas Witt</ td ></ tr >
< tr >< th class = "docinfo-name" > Contact:</ th >
< td >< a class = "first reference" href = "mailto:dave@boost-consulting.com" > dave@ boost-consulting.com</ a > , < a class = "reference" href = "mailto:jsiek@osl.iu.edu" > jsiek@ osl.iu.edu</ a > , < a class = "last reference" href = "mailto:witt@ive.uni-hannover.de" > witt@ ive.uni-hannover.de</ a ></ td ></ tr >
< tr >< th class = "docinfo-name" > Organization:</ th >
< td >< a class = "first reference" href = "http://www.boost-consulting.com" > Boost Consulting</ a > , Indiana University < a class = "reference" href = "http://www.osl.iu.edu" > Open Systems
Lab</ a > , University of Hanover < a class = "last reference" href = "http://www.ive.uni-hannover.de" > Institute for Transport
Railway Operation and Construction</ a ></ td ></ tr >
< tr >< th class = "docinfo-name" > Date:</ th >
2004-01-13 02:58:21 +00:00
< td > 2004-01-13</ td ></ tr >
2003-08-05 19:48:41 +00:00
< tr >< th class = "docinfo-name" > Copyright:</ th >
2004-01-12 01:30:47 +00:00
< td > Copyright David Abrahams, Jeremy Siek, and Thomas Witt 2003. All rights reserved</ td ></ tr >
2003-08-05 19:48:41 +00:00
</ tbody >
</ table >
< table class = "field-list" frame = "void" rules = "none" >
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
2004-01-13 02:58:21 +00:00
< tr class = "field" >< th class = "field-name" > abstract:</ th >< td class = "field-body" > The transform iterator adapts an iterator by modifying the
< tt class = "literal" >< span class = "pre" > operator*</ span ></ tt > to apply a function object to the result of
dereferencing the iterator and returning the result.</ td >
2003-08-05 19:48:41 +00:00
</ tr >
</ tbody >
</ table >
< div class = "contents topic" id = "table-of-contents" >
< p class = "topic-title" >< a name = "table-of-contents" > Table of Contents</ a ></ p >
< ul class = "simple" >
2004-01-12 16:10:29 +00:00
< li >< a class = "reference" href = "#transform-iterator-synopsis" id = "id2" name = "id2" >< tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > synopsis</ a ></ li >
< li >< a class = "reference" href = "#transform-iterator-requirements" id = "id3" name = "id3" >< tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > requirements</ a ></ li >
< li >< a class = "reference" href = "#transform-iterator-models" id = "id4" name = "id4" >< tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > models</ a ></ li >
< li >< a class = "reference" href = "#transform-iterator-operations" id = "id5" name = "id5" >< tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > operations</ a ></ li >
< li >< a class = "reference" href = "#example" id = "id6" name = "id6" > Example</ a ></ li >
2003-08-05 19:48:41 +00:00
</ ul >
</ div >
2004-01-12 15:53:04 +00:00
< div class = "section" id = "transform-iterator-synopsis" >
2004-01-12 16:10:29 +00:00
< h1 >< a class = "toc-backref" href = "#id2" name = "transform-iterator-synopsis" >< tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > synopsis</ a ></ h1 >
2004-01-12 01:30:47 +00:00
<!-- Version 1.3 of this document was accepted for TR1 -->
2003-08-05 19:48:41 +00:00
< pre class = "literal-block" >
2004-01-12 01:30:47 +00:00
template < class UnaryFunction,
2003-08-05 19:48:41 +00:00
class Iterator,
class Reference = use_default,
class Value = use_default>
class transform_iterator
{
public:
2004-01-12 20:26:36 +00:00
typedef /* see below */ value_type;
typedef /* see below */ reference;
typedef /* see below */ pointer;
typedef iterator_traits< Iterator> ::difference_type difference_type;
typedef /* see below */ iterator_category;
2004-01-12 20:18:41 +00:00
2003-08-05 19:48:41 +00:00
transform_iterator();
2004-01-12 01:30:47 +00:00
transform_iterator(Iterator const& x, UnaryFunction f);
2003-08-05 19:48:41 +00:00
2004-01-12 01:30:47 +00:00
template< class F2, class I2, class R2, class V2>
2003-08-05 19:48:41 +00:00
transform_iterator(
2004-01-12 01:30:47 +00:00
transform_iterator< F2, I2, R2, V2> const& t
2004-01-12 18:38:32 +00:00
, typename enable_if_convertible< I2, Iterator> ::type* = 0 // exposition only
, typename enable_if_convertible< F2, UnaryFunction> ::type* = 0 // exposition only
2003-08-05 19:48:41 +00:00
);
2004-01-12 01:51:27 +00:00
Iterator base() const;
2004-01-12 01:30:47 +00:00
UnaryFunction functor() const;
2004-01-12 15:53:04 +00:00
reference operator*() const;
transform_iterator& operator++();
transform_iterator& operator--();
2003-08-05 19:48:41 +00:00
private:
2004-01-12 18:38:32 +00:00
Iterator m_iterator; // exposition only
UnaryFunction m_f; // exposition only
2003-08-05 19:48:41 +00:00
};
</ pre >
2004-01-12 20:18:41 +00:00
< p > The < tt class = "literal" >< span class = "pre" > reference</ span ></ tt > type of < tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > is
< tt class = "literal" >< span class = "pre" > result_of< UnaryFunction(iterator_traits< Iterator> ::reference)> ::type</ span ></ tt > .
2004-01-13 05:56:29 +00:00
The < tt class = "literal" >< span class = "pre" > value_type</ span ></ tt > is < tt class = "literal" >< span class = "pre" > remove_cv< remove_reference< reference> </ span > < span class = "pre" > > ::type</ span ></ tt > .</ p >
< p > The < tt class = "literal" >< span class = "pre" > iterator_category</ span ></ tt > member is a type convertible to the iterator
tag given by the following algorithm. Let < tt class = "literal" >< span class = "pre" > C</ span ></ tt > be
< tt class = "literal" >< span class = "pre" > traveral_category< Iterator> ::type</ span ></ tt > .</ p >
< pre class = "literal-block" >
if (reference is a reference to value_type) then
if (C is convertible to random_access_traversal_tag) then
random_access_iterator_tag
else if (C is convertible to bidirectional_traversal_tag) then
bidirectional_iterator_tag
else
forward_iterator_tag
else
input_iterator_tag
</ pre >
2004-01-12 15:53:04 +00:00
</ div >
2003-08-05 19:48:41 +00:00
< div class = "section" id = "transform-iterator-requirements" >
2004-01-12 16:10:29 +00:00
< h1 >< a class = "toc-backref" href = "#id3" name = "transform-iterator-requirements" >< tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > requirements</ a ></ h1 >
2004-01-12 01:30:47 +00:00
< p > The type < tt class = "literal" >< span class = "pre" > UnaryFunction</ span ></ tt > must be Assignable, Copy Constructible, and
the expression < tt class = "literal" >< span class = "pre" > f(*i)</ span ></ tt > must be valid where < tt class = "literal" >< span class = "pre" > f</ span ></ tt > is an object of
type < tt class = "literal" >< span class = "pre" > UnaryFunction</ span ></ tt > , < tt class = "literal" >< span class = "pre" > i</ span ></ tt > is an object of type < tt class = "literal" >< span class = "pre" > Iterator</ span ></ tt > , and
where the type of < tt class = "literal" >< span class = "pre" > f(*i)</ span ></ tt > must be
< tt class = "literal" >< span class = "pre" > result_of< UnaryFunction(iterator_traits< Iterator> ::reference)> ::type</ span ></ tt > .</ p >
2004-01-12 20:18:41 +00:00
< p > The argument < tt class = "literal" >< span class = "pre" > Iterator</ span ></ tt > shall model Readable Iterator.</ p >
2004-01-12 01:51:27 +00:00
</ div >
< div class = "section" id = "transform-iterator-models" >
2004-01-12 16:10:29 +00:00
< h1 >< a class = "toc-backref" href = "#id4" name = "transform-iterator-models" >< tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > models</ a ></ h1 >
2004-01-12 01:51:27 +00:00
< p > The resulting < tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > models the most refined of the
2003-08-05 19:48:41 +00:00
following options that is also modeled by < tt class = "literal" >< span class = "pre" > Iterator</ span ></ tt > .</ p >
< blockquote >
< ul class = "simple" >
2004-01-12 20:18:41 +00:00
< li > Writable Lvalue Iterator if < tt class = "literal" >< span class = "pre" > transform_iterator::reference</ span ></ tt > is a non-const reference.</ li >
< li > Readable Lvalue Iterator if < tt class = "literal" >< span class = "pre" > transform_iterator::reference</ span ></ tt > is a const reference.</ li >
2003-08-05 19:48:41 +00:00
< li > Readable Iterator otherwise.</ li >
</ ul >
</ blockquote >
< p > The < tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > models the most refined standard traversal
2004-01-12 20:18:41 +00:00
concept that is modeled by the < tt class = "literal" >< span class = "pre" > Iterator</ span ></ tt > argument.</ p >
< p > If < tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > is a model of Readable Lvalue Iterator then
it models the following original iterator concepts depending on what
the < tt class = "literal" >< span class = "pre" > Iterator</ span ></ tt > argument models.</ p >
2004-01-13 15:59:47 +00:00
< table border class = "table" >
2004-01-12 20:18:41 +00:00
< colgroup >
< col width = "51%" />
< col width = "49%" />
</ colgroup >
< thead valign = "bottom" >
< tr >< th > If < tt class = "literal" >< span class = "pre" > Iterator</ span ></ tt > models</ th >
< th > then < tt class = "literal" >< span class = "pre" > filter_iterator</ span ></ tt > models</ th >
</ tr >
</ thead >
< tbody valign = "top" >
< tr >< td > Single Pass Iterator</ td >
< td > Input Iterator</ td >
</ tr >
< tr >< td > Forward Traversal Iterator</ td >
< td > Forward Iterator</ td >
</ tr >
< tr >< td > Bidirectional Traversal Iterator</ td >
< td > Bidirectional Iterator</ td >
</ tr >
< tr >< td > Random Access Traversal Iterator</ td >
< td > Random Access Iterator</ td >
</ tr >
</ tbody >
</ table >
< p > If < tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > models Writable Lvalue Iterator then it is a
mutable iterator (as defined in the old iterator requirements).</ p >
2003-08-05 19:48:41 +00:00
</ div >
2004-01-12 01:51:27 +00:00
< div class = "section" id = "transform-iterator-operations" >
2004-01-12 16:10:29 +00:00
< h1 >< a class = "toc-backref" href = "#id5" name = "transform-iterator-operations" >< tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > operations</ a ></ h1 >
2004-01-12 15:53:04 +00:00
< p > In addition to the operations required by the concepts modeled by
< tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > , < tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > provides the following
operations.</ p >
2003-08-05 19:48:41 +00:00
< p >< tt class = "literal" >< span class = "pre" > transform_iterator();</ span ></ tt ></ p >
< table class = "field-list" frame = "void" rules = "none" >
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
< tr class = "field" >< th class = "field-name" > Returns:</ th >< td class = "field-body" > An instance of < tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > with < tt class = "literal" >< span class = "pre" > m_f</ span ></ tt >
and < tt class = "literal" >< span class = "pre" > m_iterator</ span ></ tt > default constructed.</ td >
</ tr >
</ tbody >
</ table >
2004-01-12 01:30:47 +00:00
< p >< tt class = "literal" >< span class = "pre" > transform_iterator(Iterator</ span > < span class = "pre" > const& </ span > < span class = "pre" > x,</ span > < span class = "pre" > UnaryFunction</ span > < span class = "pre" > f);</ span ></ tt ></ p >
2003-08-05 19:48:41 +00:00
< table class = "field-list" frame = "void" rules = "none" >
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
< tr class = "field" >< th class = "field-name" > Returns:</ th >< td class = "field-body" > An instance of < tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > with < tt class = "literal" >< span class = "pre" > m_f</ span ></ tt >
initialized to < tt class = "literal" >< span class = "pre" > f</ span ></ tt > and < tt class = "literal" >< span class = "pre" > m_iterator</ span ></ tt > initialized to < tt class = "literal" >< span class = "pre" > x</ span ></ tt > .</ td >
</ tr >
</ tbody >
</ table >
< pre class = "literal-block" >
template< class OtherIterator, class R2, class V2>
transform_iterator(
2004-01-12 01:30:47 +00:00
transform_iterator< UnaryFunction, OtherIterator, R2, V2> const& t
2003-08-05 19:48:41 +00:00
, typename enable_if_convertible< OtherIterator, Iterator> ::type* = 0 // exposition
);
</ pre >
< table class = "field-list" frame = "void" rules = "none" >
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
< tr class = "field" >< th class = "field-name" > Returns:</ th >< td class = "field-body" > An instance of < tt class = "literal" >< span class = "pre" > transform_iterator</ span ></ tt > that is a copy of < tt class = "literal" >< span class = "pre" > t</ span ></ tt > .</ td >
</ tr >
< tr class = "field" >< th class = "field-name" > Requires:</ th >< td class = "field-body" >< tt class = "literal" >< span class = "pre" > OtherIterator</ span ></ tt > is implicitly convertible to < tt class = "literal" >< span class = "pre" > Iterator</ span ></ tt > .</ td >
</ tr >
</ tbody >
</ table >
2004-01-12 01:51:27 +00:00
< p >< tt class = "literal" >< span class = "pre" > Iterator</ span > < span class = "pre" > base()</ span > < span class = "pre" > const;</ span ></ tt ></ p >
< table class = "field-list" frame = "void" rules = "none" >
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
< tr class = "field" >< th class = "field-name" > Returns:</ th >< td class = "field-body" >< tt class = "literal" >< span class = "pre" > m_iterator</ span ></ tt ></ td >
</ tr >
</ tbody >
</ table >
2004-01-12 01:30:47 +00:00
< p >< tt class = "literal" >< span class = "pre" > UnaryFunction</ span > < span class = "pre" > functor()</ span > < span class = "pre" > const;</ span ></ tt ></ p >
2003-08-05 19:48:41 +00:00
< table class = "field-list" frame = "void" rules = "none" >
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
< tr class = "field" >< th class = "field-name" > Returns:</ th >< td class = "field-body" >< tt class = "literal" >< span class = "pre" > m_f</ span ></ tt ></ td >
</ tr >
</ tbody >
</ table >
2004-01-12 01:51:27 +00:00
< p >< tt class = "literal" >< span class = "pre" > reference</ span > < span class = "pre" > operator*()</ span > < span class = "pre" > const;</ span ></ tt ></ p >
2003-08-05 19:48:41 +00:00
< table class = "field-list" frame = "void" rules = "none" >
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
2004-01-12 01:51:27 +00:00
< tr class = "field" >< th class = "field-name" > Returns:</ th >< td class = "field-body" >< tt class = "literal" >< span class = "pre" > m_f(*m_iterator)</ span ></ tt ></ td >
</ tr >
</ tbody >
</ table >
< p >< tt class = "literal" >< span class = "pre" > transform_iterator& </ span > < span class = "pre" > operator++();</ span ></ tt ></ p >
< table class = "field-list" frame = "void" rules = "none" >
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
< tr class = "field" >< th class = "field-name" > Effects:</ th >< td class = "field-body" >< tt class = "literal" >< span class = "pre" > ++m_iterator</ span ></ tt ></ td >
</ tr >
< tr class = "field" >< th class = "field-name" > Returns:</ th >< td class = "field-body" >< tt class = "literal" >< span class = "pre" > *this</ span ></ tt ></ td >
</ tr >
</ tbody >
</ table >
2004-01-12 15:53:04 +00:00
< p >< tt class = "literal" >< span class = "pre" > transform_iterator& </ span > < span class = "pre" > operator--();</ span ></ tt ></ p >
< table class = "field-list" frame = "void" rules = "none" >
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
< tr class = "field" >< th class = "field-name" > Effects:</ th >< td class = "field-body" >< tt class = "literal" >< span class = "pre" > --m_iterator</ span ></ tt ></ td >
</ tr >
< tr class = "field" >< th class = "field-name" > Returns:</ th >< td class = "field-body" >< tt class = "literal" >< span class = "pre" > *this</ span ></ tt ></ td >
</ tr >
</ tbody >
</ table >
2004-01-12 01:51:27 +00:00
< pre class = "literal-block" >
template < class UnaryFunction, class Iterator>
transform_iterator< UnaryFunction, Iterator>
make_transform_iterator(Iterator it, UnaryFunction fun);
</ pre >
< table class = "field-list" frame = "void" rules = "none" >
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
< tr class = "field" >< th class = "field-name" > Returns:</ th >< td class = "field-body" > An instance of < tt class = "literal" >< span class = "pre" > transform_iterator< UnaryFunction,</ span > < span class = "pre" > Iterator> </ span ></ tt > with < tt class = "literal" >< span class = "pre" > m_f</ span ></ tt >
initialized to < tt class = "literal" >< span class = "pre" > f</ span ></ tt > and < tt class = "literal" >< span class = "pre" > m_iterator</ span ></ tt > initialized to < tt class = "literal" >< span class = "pre" > x</ span ></ tt > .</ td >
</ tr >
</ tbody >
</ table >
< pre class = "literal-block" >
template < class UnaryFunction, class Iterator>
transform_iterator< UnaryFunction, Iterator>
make_transform_iterator(Iterator it);
</ pre >
< table class = "field-list" frame = "void" rules = "none" >
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
2004-01-12 01:52:47 +00:00
< tr class = "field" >< th class = "field-name" > Returns:</ th >< td class = "field-body" > An instance of < tt class = "literal" >< span class = "pre" > transform_iterator< UnaryFunction,</ span > < span class = "pre" > Iterator> </ span ></ tt > with < tt class = "literal" >< span class = "pre" > m_f</ span ></ tt >
2004-01-12 01:51:27 +00:00
default constructed and < tt class = "literal" >< span class = "pre" > m_iterator</ span ></ tt > initialized to < tt class = "literal" >< span class = "pre" > x</ span ></ tt > .</ td >
2003-08-05 19:48:41 +00:00
</ tr >
</ tbody >
</ table >
</ div >
2004-01-12 01:51:27 +00:00
< div class = "section" id = "example" >
2004-01-12 16:10:29 +00:00
< h1 >< a class = "toc-backref" href = "#id6" name = "example" > Example</ a ></ h1 >
2004-01-12 01:51:27 +00:00
< p > This is a simple example of using the transform_iterators class to
generate iterators that multiply (or add to) the value returned by
dereferencing the iterator. It would be cooler to use lambda library
in this example.</ p >
< pre class = "literal-block" >
int x[] = { 1, 2, 3, 4, 5, 6, 7, 8 };
const int N = sizeof(x)/sizeof(int);
typedef boost::binder1st< std::multiplies< int> > Function;
typedef boost::transform_iterator< Function, int*> doubling_iterator;
doubling_iterator i(x, boost::bind1st(std::multiplies< int> (), 2)),
i_end(x + N, boost::bind1st(std::multiplies< int> (), 2));
std::cout << " multiplying the array by 2:" << std::endl;
while (i != i_end)
std::cout << *i++ << " " ;
std::cout << std::endl;
std::cout << " adding 4 to each element in the array:" << std::endl;
std::copy(boost::make_transform_iterator(x, boost::bind1st(std::plus< int> (), 4)),
boost::make_transform_iterator(x + N, boost::bind1st(std::plus< int> (), 4)),
std::ostream_iterator< int> (std::cout, " " ));
std::cout << std::endl;
</ pre >
< p > The output is:</ p >
< pre class = "literal-block" >
multiplying the array by 2:
2 4 6 8 10 12 14 16
adding 4 to each element in the array:
5 6 7 8 9 10 11 12
</ pre >
2004-01-12 16:10:29 +00:00
< p > The source code for this example can be found < a class = "reference" href = "../example/transform_iterator_example.cpp" > here</ a > .</ p >
2004-01-12 01:51:27 +00:00
</ div >
2003-08-05 19:48:41 +00:00
</ div >
2004-01-13 15:59:47 +00:00
< hr class = "footer" />
2004-01-12 15:26:20 +00:00
< div class = "footer" >
< a class = "reference" href = "transform_iterator.rst" > View document source</ a > .
2004-01-13 15:59:47 +00:00
Generated on: 2004-01-13 14:26 UTC.
2004-01-12 15:26:20 +00:00
Generated by < a class = "reference" href = "http://docutils.sourceforge.net/" > Docutils</ a > from < a class = "reference" href = "http://docutils.sourceforge.net/rst.html" > reStructuredText</ a > source.
</ div >
2003-08-05 19:48:41 +00:00
</ body >
</ html >
